Policies

List policies

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

namestringOptional

Search by matching name

isPrivatebooleanOptional

Search private policies

Default: false

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/policies

HTTPcURLJavaScriptPython

GET /v1/rest/policies HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "description": "text",
      "currency": "text",
      "network": "text",
      "isPrivate": true,
      "rules": [
        {
          "reviewSteps": [
            {
              "quorum": 1,
              "userIds": [
                "text"
              ]
            }
          ],
          "threshold": {
            "min": "text",
            "max": "text"
          },
          "whitelistIds": [
            "text"
          ],
          "operationType": "SEND"
        }
      ],
      "whitelists": [
        {
          "id": "text",
          "legacyId": 1,
          "name": "text",
          "status": "ACTIVE",
          "addresses": [
            {
              "name": "text",
              "currency": "text",
              "address": "text",
              "destinationTags": [
                "text"
              ]
            }
          ],
          "createdAt": "text",
          "updatedAt": "text",
          "description": "text"
        }
      ],
      "users": [
        {
          "id": "text",
          "legacyId": 1,
          "legacyViewAll": true,
          "workspaceName": "text",
          "name": "text",
          "deviceUserId": "text",
          "deviceType": "PSD",
          "role": "ADMIN",
          "pubKey": "text",
          "status": "ACTIVE",
          "isSuspended": true,
          "createdAt": "text",
          "updatedAt": "text"
        }
      ],
      "groups": [
        {
          "id": "text",
          "legacyId": 1,
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "createdAt": "text",
          "updatedAt": "text",
          "memberIds": [
            "text"
          ]
        }
      ],
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

Get a single policy

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target policy

Responses

200

Successful response

application/json

Account policy

idstringRequired

Internal unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

namestringRequired

Policy name

descriptionany ofRequired

Policy description

stringOptional

or

nullOptional

currencyany ofRequired

string · min: 1 · max: 40Optional

Will be deprecated soon, use network instead. Currency

Pattern: ^\w+$

or

nullOptional

networkany ofRequired

string · min: 1 · max: 40Optional

Network (Same as currency for now)

Pattern: ^\w+$

or

nullOptional

isPrivatebooleanRequired

Whether the policy is private

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/policies/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/policies/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "legacyId": 1,
  "name": "text",
  "description": "text",
  "currency": "text",
  "network": "text",
  "isPrivate": true,
  "rules": [
    {
      "reviewSteps": [
        {
          "quorum": 1,
          "userIds": [
            "text"
          ]
        }
      ],
      "threshold": {
        "min": "text",
        "max": "text"
      },
      "whitelistIds": [
        "text"
      ],
      "operationType": "SEND"
    }
  ],
  "whitelists": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "status": "ACTIVE",
      "addresses": [
        {
          "name": "text",
          "currency": "text",
          "address": "text",
          "destinationTags": [
            "text"
          ]
        }
      ],
      "createdAt": "text",
      "updatedAt": "text",
      "description": "text"
    }
  ],
  "users": [
    {
      "id": "text",
      "legacyId": 1,
      "legacyViewAll": true,
      "workspaceName": "text",
      "name": "text",
      "deviceUserId": "text",
      "deviceType": "PSD",
      "role": "ADMIN",
      "pubKey": "text",
      "status": "ACTIVE",
      "isSuspended": true,
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "groups": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "createdAt": "text",
      "updatedAt": "text",
      "memberIds": [
        "text"
      ]
    }
  ],
  "createdAt": "text",
  "updatedAt": "text"
}