List available connector types with their configuration fields

GET

/v1/console/connectors

curl --request GET \
  --url https://example.com/v1/console/connectors \
  --header 'Authorization: Bearer <token>'

• this engine

Lists the connector types this build offers, each with the configuration fields it accepts.

Authorizations

• bearerAuth
• browserSession

Responses

200

OK

Media type application/json

object

connectors

Array<object>

object

description

string

fields

Array<object>

object

default

string

description

string

key

string

required

boolean

secret

boolean

type

string

Allowed values: string int bool duration

fields_known

boolean

hosting

Where the observed system runs, DERIVED from the connector’s own declared endpoint defaults: self_hosted (its default endpoint is on the loopback host — the operator runs it), vendor_hosted (a routable vendor URL), or unknown (it declares no endpoint, or it is an out-of-process plugin the host cannot introspect). unknown is a real third answer and is never a synonym for vendor_hosted.

string

Allowed values: self_hosted vendor_hosted unknown

kind

string

title

string

transport

string

Example

{
  "connectors": [
    {
      "fields": [
        {
          "type": "string"
        }
      ],
      "hosting": "self_hosted"
    }
  ]
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}