Skip to main content
POST
Create an HTTP policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Display name. It does not need to be unique. It must contain visible text and cannot contain tabs, line breaks, or other control characters. At most 128 characters after surrounding whitespace is trimmed.

Minimum string length: 1
Pattern: ^(?=[\t-\r\u0020\u0085\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000]*[^\t-\r\u0020\u0085\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000])[\t-\r\u0020\u0085\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000]*[^\u0000-\u001F\u007F-\u009F]+[\t-\r\u0020\u0085\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000]*$
document
object
required

Host patterns mapped to rules. Use an exact hostname, *.example.com for one direct subdomain, or * for anything not matched earlier. A hostname is at most 253 characters. A document can contain at most 100 rules in total and is at most 64 KiB when encoded.

Response

The policy.

id
string
required

Stable policy ID.

Pattern: ^hp_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
org_id
string
required

Organization that owns the policy.

name
string
required

Display name.

document
object
required

Host patterns mapped to rules. Use an exact hostname, *.example.com for one direct subdomain, or * for anything not matched earlier. A hostname is at most 253 characters. A document can contain at most 100 rules in total and is at most 64 KiB when encoded.

created_at
string<date-time>
required

When the policy was created.

updated_at
string<date-time>
required

When the policy name last changed.