v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Executor Configurations API

Update an Executor Configuration

Use this endpoint to update an existing executor configuration. Only configurations with unconfigured or configured status can be updated.

patch/v1/executors/{id}

Path parameters

idstring uuid required

Unique identifier of the executor configuration.

Request body

baseUrlstring required

Base URL of the external service.

descriptionstring

Human-readable description of this executor configuration.

metadataobject

Custom key-value pairs for tagging.

namestring required

Display name for the executor configuration.

Example request

{
  "authentication": {
    "config": {
      "key": "sk-live-abc123def456",
      "header": "X-API-Key"
    },
    "type": "api_key"
  },
  "baseUrl": "https://api.serasa.com.br/v2",
  "description": "Serasa KYC provider for identity validation",
  "endpoints": [
    {
      "method": "POST",
      "name": "validate-identity",
      "path": "/identity/validate",
      "timeout": 30
    }
  ],
  "name": "Serasa KYC"
}

Response

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

baseUrlstring

Base URL of the external service.

createdAtstring date-time

Timestamp when the configuration was created.

descriptionstring

Human-readable description.

idstring uuid

Unique identifier of the executor configuration.

lastTestedAtstring date-time

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

metadataobject

Custom metadata.

namestring

Display name.

status'unconfigured' | 'configured' | 'tested' | 'active' | 'disabled'

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

updatedAtstring date-time

Timestamp of the last update.

Example response

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