Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The policies API provides functionality that allows a administrator to add, delete or update policies
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||
---|---|---|---|---|---|---|---|
Get all policiesLists all the policies configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
type | string | Optional | Filter returned seeds to only those with the given type | description | string | Optional | Filter returned seeds to only those whose description matches the given expression
Section | |||||||
---|---|---|---|---|---|---|---|
Get all policies, filteredLists policies configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "count": { "totalItems": 3 }, "policy": [ { "id": "AAABcID5GBc=10653921-1b27-40b5-9d7a-f54ef1e3ad01", "type": "throttle", ... "description": "throttleDesc", "period": "minute", "value": 5 }, { "id": "AAABcIueWUc=14822610-a387-44cf-a5ed-3e05618efb57", "type": "throttle", "description": "throttleDesc", "period": "executionday", ... "value": 333 }] }, { "id": "e10af522-5830-4105-9886-3385499202ba", "message": "optional response message" } |
Status
"type": "route",
"description": "routim to cz",
"routeTo": "CZZZ"
}
]
} |
Status: 200
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single policyGets | ||||||||||||||||||||||
Section | ||||||||||||||||||||||
Get a single policyGet information about a single policy configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
| ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | |||||||||||||||||||||
404 | The given seed id was not found |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Addpoliciespolicy(ies)Adds one or more policies to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Request Body Parameters
Other parameters passed in the request body will depend on the type of policy being created Examples Add a single policy : Throttle type:
Route type:
DeleteIncremental type:
Example
Add multiple policies
Response
Status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
},
{
"id": "AAABcID5GBe=",
"type": "deleteIncremental",
"description": "Days before delete",
"deletesPolicy": "AFTER_DAYS",
"value": "1"
},
{
"id": "AAABcID5GBf=",
"type": "deleteIncremental",
"description": "Iterations before delete",
"deletesPolicy": "AFTER_INCREMENTALS",
"value": "2"
},
{
"id": "AAABcID5GBg=",
"description": "default immediate policy",
"deletesPolicy": "IMMEDIATE",
"deleteCheckAfterErrors": "ALWAYS"
}
]
} |
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 201, 406
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update policy(ies)Update policies in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Update policiesUpdate a policy in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
Path and Request Body Parameters
Other parameters passed in the request body will depend on the type of policy being created - see Add a Policy above Examples Update a single policy
x - at least one field must be present Example
Update multiple policies
Response
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given seed identifier was not found | 406 | Not acceptable - there was an issue validating the input
: 200, 406 |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deletepoliciespolicy(ies)Delete one or more policies from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters and Request Body ParametersQuery parameters
Examples Body Parameter
ExamplesDelete a single policy
Response
Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export policy(ies)Export one or more policy from Aspire, this endpoint needs at least the OPERATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
ExamplesDelete multiple seeds
Response
Status | |||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given seed identifier was not found | 406 | Not acceptable - there was an issue validating the input
"policies": {
"policy": [
{
"id": "<policy_id>",
"type": "deleteIncremental",
"description": "pD",
"deletesPolicy": "IMMEDIATE",
"deleteCheckAfterErrors": "ALWAYS"
},
...
]
}
}
} |
Status: 200, 404, 406
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export multiple policies, filteredExport multiple policies from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.
Filters: The connection filter definition here Response
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
|