Get connector config schema

GET

/api/connectors/{type}/schema

const url = 'http://localhost:8080/api/connectors/example/schema';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/connectors/example/schema

Returns the JSON schema describing a connector’s configuration fields.

Parameters

Path Parameters

type

required

string

Responses

200

Connector configuration schema.

application/json

object

success

required

boolean

data

required

object

key

additional properties

Example

{
  "success": true
}

404

Connector or schema not found

application/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}