Policies API
The Policies API provides endpoints for retrieving, uploading, and deleting policies.
Get Policy Names
Method | Endpoint | Description |
---|---|---|
|
| Get the names of all policies. |
Example request:
curl -k https://localhost:8080/api/policies
Get a Policy
Method | Endpoint | Description |
---|---|---|
|
| Get the content of a policy, where is the name of the policy to get. |
Example request:
curl -k https://localhost:8080/api/policies/my-policy
Example response:
{
"name": "just-phone-numbers",
"ignored": [
],
"identifiers": {
"dictionaries": [
],
"phoneNumber": {
"phoneNumberFilterStrategies": [
{
"strategy": "REDACT",
"redactionFormat": "{{{REDACTED-%t}}}"
}
]
}
}
}
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:
curl -X PUT -H "Content-Type: application/json" -k https://localhost:8080/api/profiles/my-profile -d @policy.json
Delete a Policy
Method | Endpoint | Description |
---|---|---|
|
| Delete a policy, where is the name of the policy to delete. |
Example request:
curl -X DELETE -k https://localhost:8080/api/policies/exprofile
Last modified: 08 November 2023