Sign in
Connector

Retrieve connector

Get a connector object.

get/api/v1/connectors/{connectorID}

Path parameters

connectorIDinteger required

A unique integer value identifying this connector.

Response

OK

idinteger required

ID of the connector

namestring required

Name of the connector (not visible in UI)

urlstring uri required

URL of the connector

queuesstring[] required

List of queues that use connector object

service_urlstring uri required

URL of the connector endpoint

paramsstring nullable required

Query params appended to the service_url

client_ssl_certificatestring nullable required

Client SSL certificate used to authenticate requests. Must be PEM encoded.

client_ssl_keystring nullable required

Client SSL key (write only). Must be PEM encoded. Key may not be encrypted.

authorization_type'secret_key' | 'Basic' required

String sent in HTTP header Authorization could be set to secret_key or Basic. For details see Connector API.

authorization_tokenstring required

Token sent to connector in Authorization header to ensure connector was contacted by Rossum (displayed only to admin user).

asynchronousboolean required

Affects exporting: when true, confirm endpoint returns immediately and connector's save endpoint is called asynchronously later on.

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 1500,
  "name": "MyQ Connector",
  "url": "https://example.rossum.app/api/v1/connectors/1500",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "service_url": "https://myq.east-west-trading.com",
  "params": "strict=true",
  "client_ssl_certificate": "-----BEGIN CERTIFICATE-----\n...",
  "authorization_type": "secret_key",
  "authorization_token": "wuNg0OenyaeK4eenOovi7aiF",
  "asynchronous": true,
  "metadata": {
    "some_key": "some_value"
  },
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.