Skip to content
Asqary Docs

List policies

GET
/v1/policies
curl --request GET \
  --url 'https://api-staging.asqary.com/v1/policies?include_archived=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
include_archived
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Policies (an organisation with none gets a seeded default policy)

Media typeapplication/json
object
policies
required
Array<object>
object
policy_id
required
string
/^pol_[0-9a-f]{32}$/
name
required
string
description
required
string | null
product
required
string | null
status
required
string
Allowed values: draft active archived
active_version
required
integer | null
latest_version
required
integer
created_at
required
string format: date-time
updated_at
required
string format: date-time
archived_at
required
string | null format: date-time
versions

Newest first. Present on single-policy responses.

Array<object>
object
version_id
required
string
/^plv_[0-9a-f]{32}$/
version
required
integer
status
required
string
Allowed values: draft tested active archived
rules
required
Array<object>
object
code
required
string
version
required
integer
enabled
required
boolean
weight
required
number
config
required
object
key
additional properties
any
thresholds
required
object
medium
required
number
high
required
number
critical
required
number
actions
required
object
low
required
string
Allowed values: approve step_up manual_review block
medium
required
string
Allowed values: approve step_up manual_review block
high
required
string
Allowed values: approve step_up manual_review block
critical
required
string
Allowed values: approve step_up manual_review block
market
required
object
code
string
currency
string
timezone
string
spec
required

The configuration as submitted.

object
key
additional properties
any
config_sha256
required

SHA-256 of the resolved configuration.

string
engine_version
required
string
created_at
required
string format: date-time
tested_at
string | null format: date-time
activated_at
string | null format: date-time
archived_at
string | null format: date-time
first_used_at
string | null format: date-time

Example 

{
  "policies": [
    {
      "status": "draft",
      "versions": [
        {
          "status": "draft",
          "actions": {
            "low": "approve",
            "medium": "approve",
            "high": "approve",
            "critical": "approve"
          }
        }
      ]
    }
  ]
}

401

Section titled “401”

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}

403

Section titled “403”

Missing scope or role, IP not allowed, or monthly quota exceeded (quota_exceeded).

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}