GithubHome

Manage Connections

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
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
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.

No content
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

PreviousTransit Encryption Key

Last updated