Pular para o conteúdo principal
PATCH
/
v1
/
executors
/
{id}
Atualizar uma configuração de executor
curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/executors/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "authentication": {
    "type": "api_key",
    "config": {
      "key": "sk-live-abc123def456",
      "header": "X-API-Key"
    }
  },
  "baseUrl": "https://api.serasa.com.br/v2",
  "endpoints": [
    {
      "method": "POST",
      "name": "validate-identity",
      "path": "/identity/validate",
      "timeout": 30
    }
  ],
  "name": "Serasa KYC",
  "description": "Serasa KYC provider for identity validation",
  "metadata": {}
}
'
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "name": "Serasa KYC",
  "description": "Serasa identity validation service",
  "baseUrl": "https://api.serasa.com.br/v2",
  "endpoints": [
    {
      "name": "validate-identity",
      "path": "/identity/validate",
      "method": "POST",
      "timeout": 30
    }
  ],
  "authentication": {
    "type": "api_key",
    "config": {
      "key": "********",
      "header": "X-API-Key"
    }
  },
  "status": "active",
  "metadata": {},
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-16T09:30:00Z",
  "lastTestedAt": "2026-03-16T09:30:00Z"
}

Autorizações

​
X-API-Key
string
header
obrigatório

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Parâmetros de caminho

​
id
string<uuid>
obrigatório

Identificador único da configuração do executor.

Corpo

application/json

Corpo da solicitação contendo os detalhes atualizados da configuração do executor.

​
authentication
object
obrigatório
​
baseUrl
string
obrigatório

URL base do serviço externo.

Maximum string length: 500
Exemplo:

"https://api.serasa.com.br/v2"

​
endpoints
object[]
obrigatório

Lista de endpoints HTTP expostos por este executor.

Minimum array length: 1
​
name
string
obrigatório

Nome de exibição da configuração do executor.

Required string length: 1 - 100
Exemplo:

"Serasa KYC"

​
description
string

Descrição legível por humanos desta configuração de executor.

Maximum string length: 500
Exemplo:

"Serasa KYC provider for identity validation"

​
metadata
object

Pares chave-valor personalizados para etiquetagem.

Resposta

Indica que a solicitação foi bem-sucedida e a resposta contém os dados solicitados.

​
authentication
object
​
baseUrl
string

URL base do serviço externo.

Exemplo:

"https://api.serasa.com.br/v2"

​
createdAt
string<date-time>

Marca temporal de quando a configuração foi criada.

Exemplo:

"2026-03-15T10:00:00Z"

​
description
string

Descrição legível por humanos.

Exemplo:

"Serasa identity validation service"

​
endpoints
object[]

Lista de endpoints HTTP configurados.

​
id
string<uuid>

Identificador único da configuração do executor.

Exemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

​
lastTestedAt
string<date-time>

Marca temporal do último teste de conectividade. Nulo se nunca testado.

Exemplo:

"2026-03-16T09:30:00Z"

​
metadata
object

Metadados personalizados.

​
name
string

Nome de exibição.

Exemplo:

"Serasa KYC"

​
status
enum<string>

Status atual do ciclo de vida: unconfigured, configured, tested, active ou disabled.

Opções disponíveis:
unconfigured,
configured,
tested,
active,
disabled
Exemplo:

"active"

​
updatedAt
string<date-time>

Marca temporal da última atualização.

Exemplo:

"2026-03-16T09:30:00Z"