Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The policy policies API provides functionality that allows a administrator to add, delete or update policies
Table of Contents |
---|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Get all policiesLists all the policies configured in the Aspire
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single policyGet information about a single policy configured in Aspire
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Adda policypoliciesAdds one policy or more policies to Aspire
Request Body Parameters
Other parameters passed in the request body will depend on the type of policy being created Examples Add a single policy
Add multiple policies
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Updatea policypoliciesUpdate 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 API above Examples Update a single policy
Update multiple policies
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deletepolicy(policies)Delete one or more policies from Aspire.
Path and Request Body Parameters
Examples Delete a single policy
Delete multiple seeds
Delete multiple policies (alternative form)
Response
Status
|