Ctrlk
MobiusFlow Website
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Services

Add a MobiusFlow service to a node

post
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
Body
sidstring · min: 3 · max: 3Required

The SID of the service. If this SID is already used the next available one will be used

Example: 020Pattern: \b[0-9A-F]{3}$\b
spidstring · min: 4 · max: 4Required

The servive profile ID of the service

Example: 000APattern: \b[0-9A-F]{4}$\b
namestringOptional

The name of the service

enabledbooleanOptional

Is the service is enabled?

runAtStartbooleanOptional

Should the service should run at start?

Responses
201

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

post/api/engine/v3/service/{hid}
POST /api/engine/v3/service/{hid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "sid": "020",
  "spid": "000A",
  "name": "text",
  "enabled": true,
  "runAtStart": true
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "enabled": true,
      "runAtStart": true
    }
  ]
}

Clone a MobiusFlow service in a node

post

Clone a service one or more times. The new service SIDs will be sequential (skipping any existing service SIDs) from the start SID or 020 if not provided.

Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Body
copiesnumberRequired

The number of copies to make

startstring · min: 3 · max: 3Optional

The SID of the first clone

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
201

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

post/api/engine/v3/service/clone/{hid}/{sid}
POST /api/engine/v3/service/clone/{hid}/{sid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "copies": 1,
  "start": "020"
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "enabled": true,
      "runAtStart": true
    }
  ]
}

Delete a MobiusFlow service from a node

delete
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

delete/api/engine/v3/service/{hid}/{sid}
DELETE /api/engine/v3/service/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "enabled": true,
      "runAtStart": true
    }
  ]
}

Start a MobiusFlow service

post
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json

Success response

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

post/api/engine/v3/service/start/{hid}/{sid}
POST /api/engine/v3/service/start/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text"
}

Stop a MobiusFlow service

post
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json

Success response

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

post/api/engine/v3/service/stop/{hid}/{sid}
POST /api/engine/v3/service/stop/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text"
}

Hot reload a MobiusFlow service

post

Refresh all objects from a service configuration

Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json

Success response

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

post/api/engine/v3/service/reload/{hid}/{sid}
POST /api/engine/v3/service/reload/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text"
}

Get a MobiusFlow service's configuration

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

get/api/engine/v3/service/config/{hid}/{sid}
GET /api/engine/v3/service/config/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Update a MobiusFlow service's configuration

patch
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Body
namestringOptional

The name of the service

enabledbooleanOptional

Is the service is enabled?

runAtStartbooleanOptional

Should the service should run at start?

Responses
200

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

patch/api/engine/v3/service/config/{hid}/{sid}
PATCH /api/engine/v3/service/config/{hid}/{sid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "name": "text",
  "enabled": true,
  "runAtStart": true,
  "custom": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Update a MobiusFlow service's SID

patch
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Body

The new SID

sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

patch/api/engine/v3/service/config/sid/{hid}/{sid}
PATCH /api/engine/v3/service/config/sid/{hid}/{sid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "sid": "020"
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Replace all objects in a MobiusFlow service's configuration

put
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Body
Responses
200

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

put/api/engine/v3/service/config/replace-all-objects/{hid}/{sid}
PUT /api/engine/v3/service/config/replace-all-objects/{hid}/{sid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "objects": [
    {
      "pid": "002F",
      "ins": "0001",
      "configIsDirty": true,
      "rids": [
        {
          "rid": "40",
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ],
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {
          "value": "text",
          "from": "profile"
        }
      }
    }
  ]
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "name": "text",
    "enabled": true,
    "runAtStart": true,
    "config": {
      "sid": "020",
      "spid": "000A",
      "settings": {
        "timeouts": {
          "local": 1,
          "remote": 1
        },
        "persistence": {
          "enabled": true,
          "interval": 1
        },
        "logging": {
          "spoke": {
            "level": "trace"
          },
          "service": {
            "level": "trace"
          }
        }
      },
      "custom": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "objects": [
        {
          "pid": "002F",
          "ins": "0001",
          "configIsDirty": true,
          "rids": [
            {
              "rid": "40",
              "settings": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "value": "text",
                  "from": "profile"
                }
              }
            }
          ],
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "profile"
            }
          }
        }
      ]
    }
  }
}

Get the logging level of a MobiusFlow service

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

get/api/engine/v3/service/config/log-levels/{hid}/{sid}
GET /api/engine/v3/service/config/log-levels/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "spoke": "trace",
    "service": "trace"
  }
}

Set the logging level of a MobiusFlow service

patch
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Body

The new logging levels for the service and spoke

spokestring · enumRequired

Log level

Possible values:
servicestring · enumRequired

Log level

Possible values:
Responses
200

Default Response

application/json

Success response

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

patch/api/engine/v3/service/config/log-levels/{hid}/{sid}
PATCH /api/engine/v3/service/config/log-levels/{hid}/{sid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "spoke": "trace",
  "service": "trace"
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text"
}

Get the persistence settings of a MobiusFlow service

get
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json
tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

get/api/engine/v3/service/config/persistence/{hid}/{sid}
GET /api/engine/v3/service/config/persistence/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text",
  "data": {
    "enabled": true,
    "interval": 1
  }
}

Set the persistence settings of a MobiusFlow service

patch
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Body

The new persistence settings for the service

enabledbooleanRequired

Is persistence enabled for the service?

intervalnumber · min: 1Required

The persistence interval in seconds

Responses
200

Default Response

application/json

Success response

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

patch/api/engine/v3/service/config/persistence/{hid}/{sid}
PATCH /api/engine/v3/service/config/persistence/{hid}/{sid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "enabled": true,
  "interval": 1
}
{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text"
}

Persist all objects in a MobiusFlow service

post
Path parameters
hidstring · min: 6 · max: 6Required

Hub ID (HID)

Example: 000001Pattern: \b^[0-9A-F]{6}$\b
sidstring · min: 3 · max: 3Required

Service ID (SID)

Example: 020Pattern: \b[0-9A-F]{3}$\b
Responses
200

Default Response

application/json

Success response

tsstringRequired

Timestamp of the response

Example: 2025-01-01T00:00:00.000Z
uristringRequired

URI of the response

post/api/engine/v3/service/persist-objects/{hid}/{sid}
POST /api/engine/v3/service/persist-objects/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "uri": "text"
}
PreviousDiscover
NextObjects

Last updated

Was this helpful?