OpenAPI SpecificationJSON
API Reference

Connector

A connector is an extension of Rossum that allows to validate and modify data during validation and also export data to an external system. A connector object is used to configure external or internal endpoint of such an extension service. For more information see Extensions

Connector

Attribute
Type
Description
id*
read-only
integer

ID of the connector

name*
string

Name of the connector (not visible in UI)

url*
read-only
URL

URL of the connector

queues*
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params*
string | null

Query params appended to the service_url

client_ssl_certificate*
string | null

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

client_ssl_key*
write-only
string | null

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

authorization_type*
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token*
string

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

asynchronous*
boolean

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

Default: true
metadata*
object

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

Default: {}
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

List connectors

Retrieve all connector objects.

GET
/api/v1/connectors
curl -X GET "https://example.rossum.app/api/v1/connectors"
{
  "pagination": {
    "next": null,
    "previous": null
  },
  "results": [
    {
      "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...",
      "client_ssl_key": "string",
      "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"
    }
  ]
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

OK

Attribute
Type
Description
pagination*
pagination
next
URL

URL for the next page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.

previous
URL

URL for the previous page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

results*
list[connector]
id*
read-only
integer

ID of the connector

name*
string

Name of the connector (not visible in UI)

url*
read-only
URL

URL of the connector

queues*
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params*
string | null

Query params appended to the service_url

client_ssl_certificate*
string | null

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

authorization_type*
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token*
string

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

asynchronous*
boolean

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

Default: true
metadata*
object

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

Default: {}
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Create connector

Create a new connector object.

POST
/api/v1/connectors
curl -X POST "https://example.rossum.app/api/v1/connectors" \  -H "Content-Type: application/json" \  -d '{    "name": "MyQ Connector",    "service_url": "https://myq.east-west-trading.com"  }'
{
  "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...",
  "client_ssl_key": "string",
  "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"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name*
string

Name of the connector (not visible in UI)

queues
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params
string | null

Query params appended to the service_url

client_ssl_certificate
string | null

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

client_ssl_key
write-only
string | null

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

authorization_type
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token
string

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

asynchronous
boolean

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

Default: true
metadata
object

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

Default: {}

Response

201Created

Created

Attribute
Type
Description
id*
read-only
integer

ID of the connector

name*
string

Name of the connector (not visible in UI)

url*
read-only
URL

URL of the connector

queues*
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params*
string | null

Query params appended to the service_url

client_ssl_certificate*
string | null

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

authorization_type*
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token*
string

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

asynchronous*
boolean

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

Default: true
metadata*
object

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

Default: {}
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Retrieve connector

Get a connector object.

GET
/api/v1/connectors/{connectorID}
curl -X GET "https://example.rossum.app/api/v1/connectors/0"
{
  "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...",
  "client_ssl_key": "string",
  "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"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer

ID of the connector

name*
string

Name of the connector (not visible in UI)

url*
read-only
URL

URL of the connector

queues*
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params*
string | null

Query params appended to the service_url

client_ssl_certificate*
string | null

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

authorization_type*
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token*
string

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

asynchronous*
boolean

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

Default: true
metadata*
object

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

Default: {}
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Partial update connector

Update part of connector object.

PATCH
/api/v1/connectors/{connectorID}
curl -X PATCH "https://example.rossum.app/api/v1/connectors/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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...",
  "client_ssl_key": "string",
  "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"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name
string

Name of the connector (not visible in UI)

queues
list[URL]

List of queues that use connector object

service_url
URL

URL of the connector endpoint

params
string | null

Query params appended to the service_url

client_ssl_certificate
string | null

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

client_ssl_key
write-only
string | null

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

authorization_type
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token
string

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

asynchronous
boolean

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

Default: true
metadata
object

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

Default: {}

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer

ID of the connector

name*
string

Name of the connector (not visible in UI)

url*
read-only
URL

URL of the connector

queues*
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params*
string | null

Query params appended to the service_url

client_ssl_certificate*
string | null

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

authorization_type*
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token*
string

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

asynchronous*
boolean

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

Default: true
metadata*
object

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

Default: {}
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Delete connector

Delete connector object.

DELETE
/api/v1/connectors/{connectorID}
curl -X DELETE "https://example.rossum.app/api/v1/connectors/0"
Empty
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

204No Content

No Content

No response body.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Update connector

Update connector object.

PUT
/api/v1/connectors/{connectorID}
curl -X PUT "https://example.rossum.app/api/v1/connectors/0" \  -H "Content-Type: application/json" \  -d '{    "name": "MyQ Connector",    "service_url": "https://myq.east-west-trading.com"  }'
{
  "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...",
  "client_ssl_key": "string",
  "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"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name*
string

Name of the connector (not visible in UI)

queues
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params
string | null

Query params appended to the service_url

client_ssl_certificate
string | null

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

client_ssl_key
write-only
string | null

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

authorization_type
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token
string

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

asynchronous
boolean

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

Default: true
metadata
object

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

Default: {}

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer

ID of the connector

name*
string

Name of the connector (not visible in UI)

url*
read-only
URL

URL of the connector

queues*
list[URL]

List of queues that use connector object

service_url*
URL

URL of the connector endpoint

params*
string | null

Query params appended to the service_url

client_ssl_certificate*
string | null

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

authorization_type*
"secret_key" | "Basic"

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

Default: "secret_key"
authorization_token*
string

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

asynchronous*
boolean

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

Default: true
metadata*
object

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

Default: {}
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

GETRetrieve automation blocker

Previous Page

GETList connectors

Next Page