Manage Connections

PreviousTransit Encryption Key

Last updated 1 month ago

List connections

get

Returns a list of connections for the client.

Authorizations

Query parameters

cursorstringOptional

Cursor for pagination. Use the next cursor from previous response to get next page

limitnumberOptional

Number of records to return per page

orderBystringOptional

Field to order results by

descstringOptional

Set to "true" or "1" for descending order

Header parameters

x-client-idstringRequired

AuthorizationstringOptional

Responses

200

Returns a paginated list of connections for the client

application/json

400

Invalid request parameters

application/json

401

Authentication is required

application/json

403

Insufficient permissions

application/json

404

Resource not found

application/json

409

Resource conflict

application/json

422

Unable to process the contained instructions

application/json

500

Internal server error

application/json

502

Bad gateway

application/json

get

GET /v1/provider/connections HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*

{
  "data": [
    {
      "clientId": "text",
      "connectionId": "text",
      "createdAt": null,
      "label": "text",
      "provider": "anchorage",
      "revokedAt": null,
      "status": "active",
      "updatedAt": null,
      "url": "https://example.com"
    }
  ],
  "page": {
    "next": "text"
  }
}

Get connection by ID

get

Returns a specific connection by ID.

Authorizations

Path parameters

connectionIdstringRequired

Header parameters

x-client-idstringRequired

AuthorizationstringOptional

Responses

200

Returns the details of the specified connection.

application/json

400

Invalid request parameters

application/json

401

Authentication is required

application/json

403

Insufficient permissions

application/json

404

Resource not found

application/json

409

Resource conflict

application/json

422

Unable to process the contained instructions

application/json

500

Internal server error

application/json

502

Bad gateway

application/json

get

GET /v1/provider/connections/{connectionId} HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*

{
  "data": {
    "clientId": "text",
    "connectionId": "text",
    "createdAt": null,
    "label": "text",
    "provider": "anchorage",
    "revokedAt": null,
    "status": "active",
    "updatedAt": null,
    "url": "https://example.com"
  }
}

Revoke connection

delete

Revokes an existing connection, terminating communication and invalidating credentials.

Authorizations

Path parameters

connectionIdstringRequired

Header parameters

x-client-idstringRequired

AuthorizationstringOptional

Responses

204

Indicates that the connection has been successfully revoked. No content is returned in the response.

400

Invalid request parameters

application/json

401

Authentication is required

application/json

403

Insufficient permissions

application/json

404

Resource not found

application/json

409

Resource conflict

application/json

422

Unable to process the contained instructions

application/json

500

Internal server error

application/json

502

Bad gateway

application/json

delete

DELETE /v1/provider/connections/{connectionId} HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*

No content