Saltar al contenido principal
PATCH
/
v1
/
executors
/
{id}
Actualizar una configuración de ejecutor
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"
}

Autorizaciones

​
X-API-Key
string
header
requerido

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

Parámetros de ruta

​
id
string<uuid>
requerido

Identificador único de la configuración del ejecutor.

Cuerpo

application/json

Cuerpo de la solicitud que contiene los detalles actualizados de la configuración del ejecutor.

​
authentication
object
requerido
​
baseUrl
string
requerido

URL base del servicio externo.

Maximum string length: 500
Ejemplo:

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

​
endpoints
object[]
requerido

Lista de endpoints HTTP expuestos por este ejecutor.

Minimum array length: 1
​
name
string
requerido

Nombre para mostrar de la configuración del ejecutor.

Required string length: 1 - 100
Ejemplo:

"Serasa KYC"

​
description
string

Descripción legible por humanos de esta configuración de ejecutor.

Maximum string length: 500
Ejemplo:

"Serasa KYC provider for identity validation"

​
metadata
object

Pares clave-valor personalizados para etiquetado.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos solicitados.

​
authentication
object
​
baseUrl
string

URL base del servicio externo.

Ejemplo:

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

​
createdAt
string<date-time>

Marca de tiempo de cuando se creó la configuración.

Ejemplo:

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

​
description
string

Descripción legible por humanos.

Ejemplo:

"Serasa identity validation service"

​
endpoints
object[]

Lista de endpoints HTTP configurados.

​
id
string<uuid>

Identificador único de la configuración del ejecutor.

Ejemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

​
lastTestedAt
string<date-time>

Marca de tiempo de la última prueba de conectividad. Nulo si nunca se probó.

Ejemplo:

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

​
metadata
object

Metadatos personalizados.

​
name
string

Nombre para mostrar.

Ejemplo:

"Serasa KYC"

​
status
enum<string>

Estado actual del ciclo de vida: unconfigured, configured, tested, active o disabled.

Opciones disponibles:
unconfigured,
configured,
tested,
active,
disabled
Ejemplo:

"active"

​
updatedAt
string<date-time>

Marca de tiempo de la última actualización.

Ejemplo:

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