Airlock API
Securing the API
Airlock's API supports one-way and two-way SSL/TLS authentication. See the SSL/TLS settings for more information.
Policies API
The Policies API provides endpoints for retrieving, uploading, and deleting policies.
Apply a Policy
Method | Endpoint | Description |
---|---|---|
|
| Applies a policy to text. |
Query Parameters
d
- Optional - A document ID that uniquely identifies the text being submitted. Leave empty and Airlock will generate a document ID derived from a hash of the submitted text.p
- Optional - The name of the policy to apply. Defaults todefault
if not provided.c
- Optional - The context. Defaults tonone
if not provided.
Example request to apply a policy to text.
Get Policy Names
Method | Endpoint | Description |
---|---|---|
|
| Get the names of all policies. |
Example request:
Get a Policy
Method | Endpoint | Description |
---|---|---|
|
| Get the content of a policy, where is the name of the policy to get. |
Example request:
Example response:
Upload a Policy
Method | Endpoint | Description |
---|---|---|
|
| Upload a policy, where is the name of the policy to get. If a policy with this name already exists it will be overwritten. |
Example request:
Delete a Policy
Method | Endpoint | Description |
---|---|---|
|
| Delete a policy, where is the name of the policy to delete. |
Example request: