Operations

Create operations

Create one or more operations based on the scope and objectives provided.

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

Returns the created operation resources with the same canonical query contract by id.

Parameter compatibility for execute_microservice

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

The values sent in payload.parameters are transmitted as text (string). The interpretation of types depends on the parameter definition and the parsing implemented in the microservice script.

For that context, recommended data types for parameters:

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).
When executed 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

Create operations

curl --request POST \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": {
    "ids": [
      "<string>"
    ]
  },
  "expiration_in_seconds": 42600,
  "payload": {}
}
'

import requests

url = "https://api.flexxible.net/v2/organizations/{organization_id}/operations"

payload = {
    "target": { "ids": ["<string>"] },
    "expiration_in_seconds": 42600,
    "payload": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({target: {ids: ['<string>']}, expiration_in_seconds: 42600, payload: {}})
};

fetch('https://api.flexxible.net/v2/organizations/{organization_id}/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flexxible.net/v2/organizations/{organization_id}/operations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target' => [
        'ids' => [
                '<string>'
        ]
    ],
    'expiration_in_seconds' => 42600,
    'payload' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flexxible.net/v2/organizations/{organization_id}/operations"

	payload := strings.NewReader("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flexxible.net/v2/organizations/{organization_id}/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flexxible.net/v2/organizations/{organization_id}/operations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "organization_id": "<string>",
      "description": "<string>",
      "status": "finished",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "microservice_id": "<string>",
      "flow_id": "<string>",
      "remote_support": {
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "type": "<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>"
  }
}

{
  "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

Maximum string length: 24

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

Body

application/json

type

enum<string>

required

Available options:

execute_microservice,

delete_workspaces,

shutdown_workspaces,

restart_workspaces,

suspend_workspaces

target

object

required

Show child attributes

expiration_in_seconds

integer

Required range: 600 <= x <= 84600

payload

object

Response

Operations created successfully.

data

object[]

required

Minimum array length: 1

Show child attributes

⌘I

Create operations

curl --request POST \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/operations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": {
    "ids": [
      "<string>"
    ]
  },
  "expiration_in_seconds": 42600,
  "payload": {}
}
'

import requests

url = "https://api.flexxible.net/v2/organizations/{organization_id}/operations"

payload = {
    "target": { "ids": ["<string>"] },
    "expiration_in_seconds": 42600,
    "payload": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({target: {ids: ['<string>']}, expiration_in_seconds: 42600, payload: {}})
};

fetch('https://api.flexxible.net/v2/organizations/{organization_id}/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flexxible.net/v2/organizations/{organization_id}/operations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target' => [
        'ids' => [
                '<string>'
        ]
    ],
    'expiration_in_seconds' => 42600,
    'payload' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flexxible.net/v2/organizations/{organization_id}/operations"

	payload := strings.NewReader("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flexxible.net/v2/organizations/{organization_id}/operations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flexxible.net/v2/organizations/{organization_id}/operations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target\": {\n    \"ids\": [\n      \"<string>\"\n    ]\n  },\n  \"expiration_in_seconds\": 42600,\n  \"payload\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "organization_id": "<string>",
      "description": "<string>",
      "status": "finished",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "microservice_id": "<string>",
      "flow_id": "<string>",
      "remote_support": {
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "type": "<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>"
  }
}

{
  "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