Manage Connections

PreviousTransit Encryption Key

Last updated 12 days 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

application/json

objectoptional

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

application/json

objectoptional

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

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