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
Table of Contents |
---|
Section | |||||||
---|---|---|---|---|---|---|---|
Get all policiesLists all the policies configured in the Aspire
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
from | integer | Optional | Indicates the initial page to be retrieved | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy | string | Optional | Field by which results are sorted | ||||
sortMode | string | Optional | Sort mode
| ||||
expand | string | Optional | List of fields to expand, * will expand everything |
Code Block | ||
---|---|---|
| ||
{ "policy": [{ "id": "AAABcID5GBc=", "type": "throttle", "description": "Europe Net Appliance throttle", "timeUnit": "m", "timeUnitRate": "1", "numberOfDocuments": "100" }, { "id": "AAABcIueWUc=", "type": "route", "description": "All servers", "tags": ["US","UK","DEU"] }] } |
Status
Response code | Description |
---|---|
200 | Success |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all policies, filteredLists policies configured in the Aspire, filtered by a specified criteria
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
from | integer | Optional | Indicates the initial page to be retrieved | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy | string | Optional | Field by which results are sorted | ||||
sortMode | string | Optional | Sort mode
| ||||
expand | string | Optional | List of fields to expand, * will expand everything | ||||
Name | Type | Required | Description | ||||
filter | JSON | Required | Filters retrieved policies. Check the filter definition here |
Code Block | ||
---|---|---|
| ||
{
"policy": [{
"id": "AAABcID5GBc=",
"type": "throttle",
"description": "Europe Net Appliance throttle",
"timeUnit": "m",
"timeUnitRate": "1",
"numberOfDocuments": "100"
},
{
"id": "AAABcIueWUc=",
"type": "route",
"description": "All servers",
"tags": ["US","UK","DEU"]
}]
} |
Status
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single policyGets information about a single policy configured in Aspire
Path Parameters
Query String Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add policiesAdds policies to Aspire
Body Parameters
Other parameters passed in the request body will depend on the type of policy being created: Throttle type:
Route type:
Example
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update policiesUpdate policies in Aspire.
Body Parameters
Other parameters passed in the request body will depend on the type of policy being created - see Add a Policy above Example
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple policies, filteredDelete multiple policies from Aspire, filtered by a specified criteria
Body Parameters
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete policyDelete a single policy from Aspire.
Path Parameters
Example
Delete multiple policies Response
Status
|
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials filter:
|