Authorizations

15 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

Create connection invite

POST/api/connection-invite/

API key permissionAuthorization: Writeauthorization:write

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object ConnectionInviteMAPI

content_typesarray of objectrequired
Items · PendingAuthorization
- namestringrequired
- content_typeintegerrequired
- app_idintegernullable
emailstring · emailrequired
email_bodystring
Default "Hello,\n\nYou are receiving this email because {{user}} has requested access to the following data source(s) in Adverity:\n\n{{links}}\n\nKind regards,\nAdverity Support"
notification_emailsarray of stringrequired
stackintegerrequired
send_invite_emailboolean
Default true

Responses

201Createdapplication/json

Response schema

object ConnectionInviteMAPI

content_typesarray of objectrequired
Items · PendingAuthorization
- namestringrequired
- content_typeintegerrequired
- app_idintegernullable
emailstring · emailrequired
email_bodystring
Default "Hello,\n\nYou are receiving this email because {{user}} has requested access to the following data source(s) in Adverity:\n\n{{links}}\n\nKind regards,\nAdverity Support"
notification_emailsarray of stringrequired
stackintegerrequired
send_invite_emailboolean
Default true

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/connection-invite/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "content_types": [
      {
        "name": "string",
        "content_type": 1,
        "app_id": 1
      }
    ],
    "email": "user@example.com",
    "email_body": "Hello,\n\nYou are receiving this email because {{user}} has requested access to the following data source(s) in Adverity:\n\n{{links}}\n\nKind regards,\nAdverity Support",
    "notification_emails": [
      "string"
    ],
    "stack": 1,
    "send_invite_email": true
  }'

Response201

{
  "content_types": [
    {
      "name": "string",
      "content_type": 1,
      "app_id": 1
    }
  ],
  "email": "user@example.com",
  "email_body": "Hello,\n\nYou are receiving this email because {{user}} has requested access to the following data source(s) in Adverity:\n\n{{links}}\n\nKind regards,\nAdverity Support",
  "notification_emails": [
    "string"
  ],
  "stack": 1,
  "send_invite_email": true
}

List connection types

GET/api/connection-types/

API key permissionAuthorization: Read-onlyauthorization:read

Query parameters

pageinteger
A page number within the paginated result set.
page_sizeinteger
Number of results to return per page.
searchstring
A search term.

Responses

200OKapplication/json

Response schema

object PaginatedConnectionTypeList

countintegerrequired
Example 123
nextstring · urinullable
Example "http://api.example.org/accounts/?page=4"
previousstring · urinullable
Example "http://api.example.org/accounts/?page=2"
resultsarray of objectrequired
Items · ConnectionType
- idintegerrequiredread-only
- namestringrequiredread-only
- slugstringrequiredread-only
- canonical_namestringrequiredread-only
- urlstring · urirequiredread-only
- categoriesarray of stringrequiredread-only
- keywordsarray of stringrequiredread-only
- is_deprecatedbooleanrequiredread-only
- logo_urlstringrequiredread-only
- create_urlstringrequiredread-only
- connectionsstring · urirequiredread-only

Get connection types

GET/api/connection-types/{id}/

API key permissionAuthorization: Read-onlyauthorization:read

Path parameters

idintegerrequired
A unique integer value identifying this content type.

Responses

200OKapplication/json

Response schema

object ConnectionType

idintegerrequiredread-only
namestringrequiredread-only
slugstringrequiredread-only
canonical_namestringrequiredread-only
urlstring · urirequiredread-only
categoriesarray of stringrequiredread-only
keywordsarray of stringrequiredread-only
is_deprecatedbooleanrequiredread-only
logo_urlstringrequiredread-only
create_urlstringrequiredread-only
connectionsstring · urirequiredread-only

List connection types connections

GET/api/connection-types/{parent_lookup_type_id}/connections/

API key permissionAuthorization: Read-onlyauthorization:read

Path parameters

parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Query parameters

creatorstring
namestring
orderingstring
Which field to use when ordering the results.
pageinteger
A page number within the paginated result set.
page_sizeinteger
Number of results to return per page.
stack_idinteger

Responses

200OKapplication/json

Response schema

object PaginatedPolymorphicConnectionBaseList

countintegerrequired
Example 123
nextstring · urinullable
Example "http://api.example.org/accounts/?page=4"
previousstring · urinullable
Example "http://api.example.org/accounts/?page=2"
resultsarray of objectrequired
Items · PolymorphicConnectionBase
- idintegerrequiredread-only
- connection_invite_uuidstringrequiredread-onlynullable
- enable_all_billing_objectsboolean
  Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
- stackintegernullable
- is_authorizedbooleanrequiredread-only
- namestringrequired
  Max length 100

Create connection types connections

POST/api/connection-types/{parent_lookup_type_id}/connections/

API key permissionAuthorization: Writeauthorization:write

Path parameters

parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PolymorphicConnectionBase

no_validatebooleanwrite-only
enable_all_billing_objectsboolean
Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
stackintegernullable
namestringrequired
Max length 100

Responses

201Createdapplication/json

Response schema

object PolymorphicConnectionBase

idintegerrequiredread-only
connection_invite_uuidstringrequiredread-onlynullable
enable_all_billing_objectsboolean
Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
stackintegernullable
is_authorizedbooleanrequiredread-only
namestringrequired
Max length 100

Get connection types connections

GET/api/connection-types/{parent_lookup_type_id}/connections/{id}/

API key permissionAuthorization: Read-onlyauthorization:read

Path parameters

idintegerrequired
The connection id.
parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Responses

200OKapplication/json

Response schema

object PolymorphicConnectionBase

idintegerrequiredread-only
connection_invite_uuidstringrequiredread-onlynullable
enable_all_billing_objectsboolean
Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
stackintegernullable
is_authorizedbooleanrequiredread-only
namestringrequired
Max length 100

Replace connection types connections

PUT/api/connection-types/{parent_lookup_type_id}/connections/{id}/

API key permissionAuthorization: Writeauthorization:write

Path parameters

idintegerrequired
The connection id.
parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PolymorphicConnectionBase

no_validatebooleanwrite-only
enable_all_billing_objectsboolean
Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
stackintegernullable
namestringrequired
Max length 100

Responses

200OKapplication/json

Response schema

object PolymorphicConnectionBase

idintegerrequiredread-only
connection_invite_uuidstringrequiredread-onlynullable
enable_all_billing_objectsboolean
Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
stackintegernullable
is_authorizedbooleanrequiredread-only
namestringrequired
Max length 100

Update connection types connections

PATCH/api/connection-types/{parent_lookup_type_id}/connections/{id}/

API key permissionAuthorization: Writeauthorization:write

Path parameters

idintegerrequired
The connection id.
parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedPolymorphicConnectionBase

no_validatebooleanwrite-only
enable_all_billing_objectsboolean
Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
stackintegernullable
namestring
Max length 100

Responses

200OKapplication/json

Response schema

object PolymorphicConnectionBase

idintegerrequiredread-only
connection_invite_uuidstringrequiredread-onlynullable
enable_all_billing_objectsboolean
Automatically enable all billing objects of the connection. Only takes effect for connection types billed per billing object. On create, any value is accepted. On update of a connection of any other type, a value different from the stored one returns 400.
stackintegernullable
is_authorizedbooleanrequiredread-only
namestringrequired
Max length 100

Delete connection types connections

DELETE/api/connection-types/{parent_lookup_type_id}/connections/{id}/

API key permissionAuthorization: Writeauthorization:write

Path parameters

idintegerrequired
The connection id.
parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Responses

204No response body

Get connection types connections authorize

GET/api/connection-types/{parent_lookup_type_id}/connections/{id}/authorize/

API key permissionAuthorization: Read-onlyauthorization:read

Path parameters

idintegerrequired
The connection id.
parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Query parameters

return_urlstring · uri
OAuth connection types only: the URL to send the user to after the authorization.

Responses

200OKapplication/json

Response schema

object ConnectionAuthorize

statusstringrequired
Always "ok".
is_oauthbooleanrequired
is_authorizedboolean
urlstring
Open this URL to start the OAuth authorization.
messagestring

Update connection types connections token

PATCH/api/connection-types/{parent_lookup_type_id}/connections/{id}/token/

API key permissionAuthorization: Writeauthorization:write

Path parameters

idintegerrequired
The connection id.
parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Request body

application/json

Body schema

object

access_tokenstringrequired
refresh_tokenstringnullable
expiresstring · date-timerequirednullable

Responses

200OKapplication/json

Response schema

object ConnectionActionStatus

statusstringrequired
"ok", or "error" when the token action is called on a connection type without OAuth (returned with 400). The update action always returns "ok". Other failures use the normal error responses, not this field.
messagestringrequired

400The connection type does not use OAuth: `status` and `message`. A request body that fails validation returns the error envelope instead: `detail`, and `errors` keyed by field.application/json

Response schema

one of

ConnectionActionStatus
- statusstringrequired
  "ok", or "error" when the token action is called on a connection type without OAuth (returned with 400). The update action always returns "ok". Other failures use the normal error responses, not this field.
- messagestringrequired
object
- detailstringrequired
- errorsobjectrequired

Create connection types connections update

POST/api/connection-types/{parent_lookup_type_id}/connections/{id}/update/

API key permissionAuthorization: Writeauthorization:write

Path parameters

idintegerrequired
The connection id.
parent_lookup_type_idstringrequired
The connection type: its integer id or its canonical_name, as listed by GET /api/connection-types/.

Responses

200OKapplication/json

Response schema

object ConnectionActionStatus

statusstringrequired
"ok", or "error" when the token action is called on a connection type without OAuth (returned with 400). The update action always returns "ok". Other failures use the normal error responses, not this field.
messagestringrequired

List connections

GET/api/connections/

API key permissionAuthorization: Read-onlyauthorization:read

Query parameters

creatorstring
namestring
orderingstring
Which field to use when ordering the results.
pageinteger
A page number within the paginated result set.
page_sizeinteger
Number of results to return per page.
stack_idinteger

Responses

200OKapplication/json

Response schema

object PaginatedAuthorizationListList

countintegerrequired
Example 123
nextstring · urinullable
Example "http://api.example.org/accounts/?page=4"
previousstring · urinullable
Example "http://api.example.org/accounts/?page=2"
resultsarray of objectrequired
Items · AuthorizationList
- idintegerrequiredread-only
- namestringrequired
  Max length 100
- stackobjectrequiredread-onlynullable
  Attributes
  - StackBasic
    idintegerrequiredread-only
    uuidstring · uuidrequiredread-only
    namestringrequired
    Max length 60
    slugstringrequiredread-only
    urlstring · urirequiredread-only
    change_urlstringrequiredread-only
    extracts_urlstringrequiredread-only
    issues_urlstringrequiredread-only
    overview_urlstringrequiredread-only
    permissionsobjectrequiredread-only
    Attributes
    isCreatorbooleanrequired
    isDatastreamManagerbooleanrequired
    isViewerbooleanrequired
  - null
- polymorphic_ctype_idintegerrequiredread-onlynullable
- connection_typestringrequiredread-only
- credentials_validatedbooleanrequiredread-only
- is_authorizedbooleanrequiredread-only
- createdstring · date-timerequiredread-only
- updatedstring · date-timerequiredread-only
- creator_usernamestringrequiredread-onlynullable
- datastream_countintegerrequiredread-only
- detail_urlstringrequiredread-only
- connection_invite_uuidstringrequiredread-onlynullable

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/connections/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "name": "string",
      "stack": {
        "id": 1,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "slug": "string",
        "url": "https://example.com",
        "change_url": "string",
        "extracts_url": "string",
        "issues_url": "string",
        "overview_url": "string",
        "permissions": {
          "isCreator": null,
          "isDatastreamManager": null,
          "isViewer": null
        }
      },
      "polymorphic_ctype_id": 1,
      "connection_type": "string",
      "credentials_validated": true,
      "is_authorized": true,
      "created": "2024-01-01T00:00:00Z",
      "updated": "2024-01-01T00:00:00Z",
      "creator_username": "string",
      "datastream_count": 1,
      "detail_url": "string",
      "connection_invite_uuid": "string"
    }
  ]
}

Rotate current Management API key.

POST/api/v1/auth/keys/current/rotate/

Responses

200OKapplication/json

Response schema

object ManagementKeyRefreshResponseSchema

api_keystringrequired

416Requested Range Not Satisfiableapplication/json

Response schema

object ErrorSchema

detailstringrequired

418I'm a Teapotapplication/json

Response schema

object ErrorSchema

detailstringrequired

451Unavailable For Legal Reasonsapplication/json

Response schema

object ErrorSchema

detailstringrequired

425Too Earlyapplication/json

Response schema

object ErrorSchema

detailstringrequired

429Too Many Requestsapplication/json

Response schema

object ErrorSchema

detailstringrequired

400Bad Requestapplication/json

Response schema

object ErrorSchema

detailstringrequired

401Unauthorizedapplication/json

Response schema

object ErrorSchema

detailstringrequired

402Payment Requiredapplication/json

Response schema

object ErrorSchema

detailstringrequired

403Forbiddenapplication/json

Response schema

object ErrorSchema

detailstringrequired

404Not Foundapplication/json

Response schema

object ErrorSchema

detailstringrequired

405Method Not Allowedapplication/json

Response schema

object ErrorSchema

detailstringrequired

406Not Acceptableapplication/json

Response schema

object ErrorSchema

detailstringrequired

407Proxy Authentication Requiredapplication/json

Response schema

object ErrorSchema

detailstringrequired

408Request Timeoutapplication/json

Response schema

object ErrorSchema

detailstringrequired

409Conflictapplication/json

Response schema

object ErrorSchema

detailstringrequired

410Goneapplication/json

Response schema

object ErrorSchema

detailstringrequired

411Length Requiredapplication/json

Response schema

object ErrorSchema

detailstringrequired

412Precondition Failedapplication/json

Response schema

object ErrorSchema

detailstringrequired

500Internal Server Errorapplication/json

Response schema

object ErrorSchema

detailstringrequired

501Not Implementedapplication/json

Response schema

object ErrorSchema

detailstringrequired

502Bad Gatewayapplication/json

Response schema

object ErrorSchema

detailstringrequired

503Service Unavailableapplication/json

Response schema

object ErrorSchema

detailstringrequired

504Gateway Timeoutapplication/json

Response schema

object ErrorSchema

detailstringrequired

Introspect the current API key.

GET/api/v1/auth/keys/introspect/

Responses

200OKapplication/json

Response schema

object KeyIntrospectionSchema

activebooleanrequired
scopesarray of stringnullable
Attributes
- array of string
- null
workspace_idstringnullable
Attributes
- string
- null
user_idstringnullable
Attributes
- string
- null
expires_atstring · date-timenullable
Attributes
- string · date-time
- null

429Too Many Requestsapplication/json

Response schema

object ErrorSchema

detailstringrequired