Create a policy

POST

/v1/policies

const url = 'https://api-staging.asqary.com/v1/policies';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","description":"example","product":"example","rules":[{"code":"example","enabled":true,"weight":1,"config":{}}],"thresholds":{"medium":1,"high":1,"critical":1},"actions":{"low":"approve","medium":"approve","high":"approve","critical":"approve"},"activate":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api-staging.asqary.com/v1/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "product": "example", "rules": [ { "code": "example", "enabled": true, "weight": 1, "config": {} } ], "thresholds": { "medium": 1, "high": 1, "critical": 1 }, "actions": { "low": "approve", "medium": "approve", "high": "approve", "critical": "approve" }, "activate": false }'

Creates a draft v1, or activates it at once with activate. Requires policies:write.

Authorizations

apiKey

Parameters

Header Parameters

Idempotency-Key

string

/^[A-Za-z0-9._:\-]{1,128}$/

Makes retries safe. Reusing a key for a different request returns 409 idempotency_key_reused.

X-Request-Id

string

/^[A-Za-z0-9._:\-]{1,128}$/

Your own request ID (1–128 of letters, digits and . _ : -), echoed back and stored.

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

description

string

product

string

/^[a-z0-9_]{1,40}$/

rules

Array<object>

object

code

required

string

enabled

boolean

weight

number

<= 1000

config

object

key

additional properties

any

thresholds

Lowest score for each level; below medium is low.

object

medium

number

high

number

critical

number

actions

object

low

string

Allowed values: approve step_up manual_review block

medium

string

Allowed values: approve step_up manual_review block

high

string

Allowed values: approve step_up manual_review block

critical

string

Allowed values: approve step_up manual_review block

activate

boolean

Responses

200

Replayed (same Idempotency-Key and request)

application/json

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

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

Headers

Idempotent-Replayed

string

Allowed values: true

Present (true) when an earlier result was returned.

201

Created

application/json

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

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

400

Malformed request (invalid_request), including unknown fields.

application/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

Array<object>

object

field

required

string

message

required

string

code

string

Example ^generated

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

401

Missing, invalid, expired or revoked API key.

application/json

object

error_code

required

string

message

required

string

retryable

required

boolean

request_id

string

details

One of:

Array<object>
object

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

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

application/json

object

error_code

required

string

message

required

string

retryable

required

boolean

request_id

string

details

One of:

Array<object>
object

Array<object>

object

field

required

string

message

required

string

code

string

Example ^generated

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

409

Lifecycle conflict (e.g. policy_in_use, policy_active) or idempotency_key_reused.

application/json

object

error_code

required

string

message

required

string

retryable

required

boolean

request_id

string

details

One of:

Array<object>
object

Array<object>

object

field

required

string

message

required

string

code

string

Example ^generated

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

422

validation_failed (details: field errors), rule_not_available, or backtest_invalid_rows.

application/json

object

error_code

required

string

message

required

string

retryable

required

boolean

request_id

string

details

One of:

Array<object>
object

Array<object>

object

field

required

string

message

required

string

code

string

Example ^generated

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

Create a policy

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example

Headers

201

Example

400

Example generated

401

Example generated

403

Example generated

409

Example generated

422

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated