Skip to main content

Limitation Policy

The following set of endpoints are intended for managing DICT access limitation policies, allowing you to query the applied policies and the status of the participant's token buckets.


List Policies​

Endpoint to retrieve the list of access limitation policies to the DICT for the requesting participant.

In addition to the list of policies, the service also informs the category in which the participant falls, according to the table in the item ENTRIES_READ_PARTICIPANT_ANTISCAN in the request-limiting section.

Each item in the list contains information about the state of the corresponding bucket at the time of the query.

GET /dict/policies
Requires authorization for the scope:


Request

The request does not require a body, only OAuth authorization headers, parameters, and the account certificate.

Responses

The responses below represent Success (200) and error/failure scenarios.

{
  "category": "A",
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "policies": [
    {
      "availableTokens": 100,
      "capacity": 1000,
      "name": "ENTRIES_READ_PARTICIPANT_ANTISCAN",
      "refillPeriodSec": 3600,
      "refillTokens": 100
    }
  ],
  "responseTime": 150
}

Get Policy​

Endpoint to retrieve details of a specific access-limitation policy.

GET /dict/policies/:policy
Requires authorization for the scope:


Request

This endpoint does not require a body, only OAuth authorization headers, parameters, and the account certificate.

Responses

Responses include Success (200) and error/failure scenarios.

{
  "Category": "A",
  "Policy": {
    "AvailableTokens": 100,
    "Capacity": 1000,
    "Name": "ENTRIES_READ_PARTICIPANT_ANTISCAN",
    "RefillPeriodSec": 3600,
    "RefillTokens": 100
  },
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "responseTime": 120
}

Last updated on