Skip to main content

Gets connector list

GET 

/connectors

Fetches list of connectors that have 'RELEASED' status using filtering and pagination. A token with ORG_ADMIN authority is required to call this API.

Request

Query Parameters

    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    name: sw

    type: eq

    directConnect: eq

    category: eq

    features: ca

    Example: directConnect eq "true"
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    locale string

    Possible values: [de, no, fi, sv, ru, pt, ko, zh-TW, en, it, fr, zh-CN, hu, es, cs, ja, pl, da, nl]

    The locale to apply to the config. If no viable locale is given, it will default to "en"

Responses

A Connector Dto object

Schema

  • Array [

  • name string

    The connector name

    type string

    The connector type

    scriptName string

    The connector script name

    className stringnullable

    The connector class name.

    features string[]nullable

    The list of features supported by the connector

    directConnect boolean

    true if the source is a direct connect source

    connectorMetadata object

    Object containing metadata pertinent to the UI to be used

    status string

    The connector status

  • ]

Loading...