Skip to main content
PATCH
/
v1
/
executors
/
{id}
Update an Executor Configuration
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"
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Unique identifier of the executor configuration.

Body

application/json

Request body containing the updated executor configuration details.

​
authentication
object
required
​
baseUrl
string
required

Base URL of the external service.

Maximum string length: 500
Example:

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

​
endpoints
object[]
required

List of HTTP endpoints exposed by this executor.

Minimum array length: 1
​
name
string
required

Display name for the executor configuration.

Required string length: 1 - 100
Example:

"Serasa KYC"

​
description
string

Human-readable description of this executor configuration.

Maximum string length: 500
Example:

"Serasa KYC provider for identity validation"

​
metadata
object

Custom key-value pairs for tagging.

Response

Indicates that the request was successful and the response contains the requested data.

​
authentication
object
​
baseUrl
string

Base URL of the external service.

Example:

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

​
createdAt
string<date-time>

Timestamp when the configuration was created.

Example:

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

​
description
string

Human-readable description.

Example:

"Serasa identity validation service"

​
endpoints
object[]

List of configured HTTP endpoints.

​
id
string<uuid>

Unique identifier of the executor configuration.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

​
lastTestedAt
string<date-time>

Timestamp of the last connectivity test. Null if never tested.

Example:

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

​
metadata
object

Custom metadata.

​
name
string

Display name.

Example:

"Serasa KYC"

​
status
enum<string>

Current lifecycle status: unconfigured, configured, tested, active, or disabled.

Available options:
unconfigured,
configured,
tested,
active,
disabled
Example:

"active"

​
updatedAt
string<date-time>

Timestamp of the last update.

Example:

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