Skip to main content
POST
/
v1
/
catalog
/
executors
/
{id}
/
validate
Validate an Executor Configuration
curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/catalog/executors/{id}/validate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config": {
    "method": "POST",
    "url": "https://api.example.com/validate"
  }
}
'
{
  "error": "",
  "valid": true
}

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
required

Unique identifier of the catalog executor.

Body

application/json

Request body containing the configuration to validate.

​
config
object

Configuration object to validate.

Example:
{
  "method": "POST",
  "url": "https://api.example.com/validate"
}

Response

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

​
error
string

Validation error message. Empty when valid.

Example:

""

​
valid
boolean

Whether the configuration passed validation.

Example:

true