FlowMate API Documentation
  1. Flows
FlowMate API Documentation
  • Authentication
    • Login
      POST
  • Flows
    • Retrieve all flows
      GET
    • Find Flow by ID
      GET
    • Deletes a flow
      DELETE
    • Update an existing flow
      PATCH
    • Bulk update a number of existing flows
      PATCH
    • Start a flow
      POST
    • Stop a flow
      POST
    • Start multiple flows
      POST
    • Stop multiple flows
      POST
  • User
    • get all users
      GET
    • Create user
      POST
    • get a user by id
      GET
    • get current user
      GET
  • Templates
    • Retrieve all flow templates
      GET
    • Add a new template to the repository
      POST
    • Find Flow Template by ID
      GET
    • Deletes a flow template
      DELETE
    • Update an existing flow template
      PATCH
    • Generate a flow from the flow template
      POST
  • Executions
    • Get Executions
      GET
  • Webhooks
    • Incoming Webhook
      POST
  1. Flows

Stop multiple flows

POST
https://api.platform.openintegrationhub.com/flows/multiple/stop
flows
Stops multiple flow's integration process by publishing an appropriate events to the event bus. Requires the 'flows.control' permission.

Request

Body Params application/json
array[string]
optional
Example
[
    "62fcb5ee8ed54c19069b0ca5"
]

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.platform.openintegrationhub.com/flows/multiple/stop' \
--header 'Content-Type: application/json' \
--data-raw '[
    "62fcb5ee8ed54c19069b0ca5"
]'

Responses

🟢200OK
application/json
Returns an array with the id and new status of the stopped flows
Body
array of:
data
object 
optional
id
string 
optional
Example:
5c99ec7e5ed40d3e7512cffa
status
string 
optional
Example:
stopping
meta
object 
optional
Example
[
    {
        "data": {
            "id": "5c99ec7e5ed40d3e7512cffa",
            "status": "stopping"
        },
        "meta": {}
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠409409
🔴500Server Error
Modified at 2025-01-16 10:16:52
Previous
Start multiple flows
Next
get all users
Built with