Operations

Create operations

Create one or several operations based on the sent scope and objectives.

Currently available operation types: execute_microservice, delete_workspaces, shutdown_workspaces, and restart_workspaces.

Parameter compatibility for execute_microservice

payload.parameters only applies to PowerShell microservices executions on Windows and is only supported on devices with the new agent installed.

Values sent in payload.parameters are transmitted as text (string). Type interpretation depends on parameter definition and parsing implemented in the microservice script.

For this context, recommended parameter data types:

string, integer, double, decimal, and datetime.
For double and decimal, use decimal point notation (.).
For datetime, use ISO 8601 format (e.g., 2026-07-09T10:30:00Z).
On execution at the destination, datetime values may be represented in local time.
Correct execution also depends on the quality and validations of the script.

POST

organizations

{organization_id}

operations

curl --request POST \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "execute_microservice",
  "target": {
    "type": "workspaces",
    "ids": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ]
  },
  "expiration_in_seconds": 600,
  "payload": {
    "microservice_id": "507f1f77bcf86cd799439015",
    "parameters": {
      "mode": "safe"
    }
  }
}
'

{
  "ids": [
    {
      "organization_id": "507f1f77bcf86cd799439011",
      "operation_id": "507f1f77bcf86cd799439031"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id

string

required

Unique organization identifier.

Maximum string length: 24

Pattern: ^[0-9a-f]{24}$

Body

application/json

type

enum<string>

required

Operation command type.

Available options:

execute_microservice,

delete_workspaces,

shutdown_workspaces,

restart_workspaces,

suspend_workspaces

target

object

required

Scope and objectives object.

Show child attributes

expiration_in_seconds

integer

Custom expiration in seconds. If omitted, the command's default value is used.

Required range: 600 <= x <= 84600

payload

object

Specific load of the operation type. Payload is not allowed for delete_workspaces/shutdown_workspaces/restart_workspaces/suspend_workspaces.

Response

Operations created successfully.

ids

object[]

required

Identifiers of operations created in the same order as they were created.

Minimum array length: 1

Show child attributes

⌘I

curl --request POST \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "execute_microservice",
  "target": {
    "type": "workspaces",
    "ids": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ]
  },
  "expiration_in_seconds": 600,
  "payload": {
    "microservice_id": "507f1f77bcf86cd799439015",
    "parameters": {
      "mode": "safe"
    }
  }
}
'

{
  "ids": [
    {
      "organization_id": "507f1f77bcf86cd799439011",
      "operation_id": "507f1f77bcf86cd799439031"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

API Gen 2

API Gen 2 resources - v2

API Gen 2 resources - v1

Create operations

Authorizations

Path Parameters

Body

Response