Get a Catalog Executor

Use this endpoint to retrieve the metadata and JSON Schema of a specific catalog executor.

GET /v1/catalog/executors/{id}

Get a Catalog Executor

cURL

curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/catalog/executors/{id} \
  --header 'X-API-Key: <api-key>'

200

{
  "category": "HTTP",
  "id": "http",
  "name": "HTTP Request",
  "providerId": "",
  "schema": "{\"type\":\"object\",\"properties\":{\"method\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"}}}",
  "version": "v1"
}

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.

Response

200

application/json

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

category · string

Functional category of the executor.

Example:

"HTTP"

id · string

Unique identifier of the executor.

Example:

"http"

name · string

Display name of the executor.

Example:

"HTTP Request"

providerId · string

ID of the provider this executor belongs to.

Example:

""

schema · string

JSON Schema defining the expected configuration for this executor.

Example:

"{\"type\":\"object\",\"properties\":{\"method\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"}}}"

version · string

Version of the executor.

Example:

"v1"