List connector types

GET

/api/connectors/types

const url = 'http://localhost:8080/api/connectors/types';
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/types

Returns metadata for every available connector type (code, not a credential). Public — no authentication required.

Responses

200

Connector type metadata.

application/json

object

success

required

boolean

data

required

Array<object>

object

type

required

string

name

required

string

version

required

string

description

required

string

author

string

supportedEntities

required

Array<string>

webhook

required

object

supported

required

boolean

provisioning

required

object

supported

required

boolean

providerLabel

required

string

storesSecretAutomatically

required

boolean

actionHint

string

secretHelpText

string

incremental

required

object

supported

required

boolean

mode

required

string

Allowed values: native client-filter created-anchor none

anchorField

string

perEntity

object

key

additional properties

object

mode

required

string

Allowed values: native client-filter created-anchor none

anchorField

string

warning

string

Example

{
  "success": true,
  "data": [
    {
      "incremental": {
        "mode": "native",
        "perEntity": {
          "additionalProperty": {
            "mode": "native"
          }
        }
      }
    }
  ]
}

500

Internal server error

application/json

object

success

boolean

error

required

string

Example

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