Operações

Criar operações

Crie uma ou várias operações com base no escopo e nos objetivos enviados.

Tipos de operação disponíveis atualmente: execute_microservice, delete_workspaces, shutdown_workspaces e restart_workspaces.

Compatibilidade de parâmetros para execute_microservice

payload.parameters aplica-se apenas a execuções de microserviços PowerShell em Windows e é suportado apenas em dispositivos com o novo agente instalado.

Os valores enviados em payload.parameters são transmitidos como texto (string). A interpretação de tipos depende da definição de parâmetros e da análise implementada no script do microserviço.

Para esse contexto, os tipos de dados de parâmetros recomendados são:

string, integer, double, decimal e datetime.
Para double e decimal, use notação decimal (.).
Para datetime, use formato ISO 8601 (por exemplo: 2026-07-09T10:30:00Z).
Na execução no destino, os valores datetime podem ser representados em horário local.
A execução correta também depende da qualidade e das validações do 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>"
  }
}

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

organization_id

string

obrigatório

Identificador único da organização.

Maximum string length: 24

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

Corpo

application/json

type

enum<string>

obrigatório

Tipo de comando de operação.

Opções disponíveis:

execute_microservice,

delete_workspaces,

shutdown_workspaces,

restart_workspaces,

suspend_workspaces

target

object

obrigatório

Objeto de alcance e objetivos.

Show child attributes

expiration_in_seconds

integer

Expiração personalizada em segundos. Se omitido, usa o valor padrão do comando.

Intervalo obrigatório: 600 <= x <= 84600

payload

object

Carga específica do tipo de operação. Para delete_workspaces/shutdown_workspaces/restart_workspaces/suspend_workspaces não é permitido payload.

Resposta

Operações criadas com sucesso.

ids

object[]

obrigatório

Identificadores de operações criadas na mesma ordem de criação.

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

Recursos API Gen 2 - v2

Recursos API Gen 2 - v1

Criar operações

Autorizações

Parâmetros de caminho

Corpo

Resposta