# MobiusFlow Engine API

The **MobiusFlow Engine API** is used interface with MobiusFlow via **http** and **https**. The API allows clients to perform all functions within MobiusFlow, from managing user accounts, to getting and setting data, as well as manipulating the MobiusFlow configuration by adding, removing and editing MobiusFlow objects, services and flows.

Additionally, the API allows clients to subscribe to specific real-time events within happening within  a given MobiusFlow instance (see [subscription controller](/help/technical-docs/mobiusflow-engine-api/subscription.md)). In this use case, the API will upgrade the client to use the Websocket protocol (**ws** / **wss**).

## Controllers

All API endpoints are described in the following subsections. The subsections are divided into the functional groups (controllers); [Authorization](/help/technical-docs/mobiusflow-engine-api/authorization.md), [Discover](/help/technical-docs/mobiusflow-engine-api/discover.md), [Node](/help/technical-docs/mobiusflow-engine-api/node.md), [Service](/help/technical-docs/mobiusflow-engine-api/service.md), [Object](/help/technical-docs/mobiusflow-engine-api/object.md), [Profiles](/help/technical-docs/mobiusflow-engine-api/profiles.md), [Command](/help/technical-docs/mobiusflow-engine-api/command.md), [Flows](/help/technical-docs/mobiusflow-engine-api/flows.md) and [Subscription](/help/technical-docs/mobiusflow-engine-api/subscription.md).

## Protocols, Endpoints and Ports

If connecting to a local instance of MobiusFlow, the http protocol can be used. If connecting to an instance of MobiusFlow via the internet, https should be used. The API is always exposed on **port 8443**.

All endpoints lead with:

{{*protocol*}}**://**{{*hostname*}}**:8443/api/v1**

Where the protocol and hostname parameters are replaced with the true protocol and hostname. For example, in the case of connecting to a local instance of MobiusFlow, the leading path would look like:

**<http://localhost:8443/api/v1>**

## Further Documentation & Postman Collection

Swagger documentation describing the API in full, can be found [here](https://docs-engine-api.mobiusflow.io/static/index.html). This documentation includes example bodies and responses for every endpoint. Finally, a postman collection containing parameterised examples of all client calls can be downloaded below.

{% file src="/files/oJpkgvmOr1oDEwrUlhF4" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mobiusflow.com/help/technical-docs/mobiusflow-engine-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.