Get all policies, filtered

Lists 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

Sorting query string parameters

Common filter

Add policy(ies)

Adds policies to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Add policies

Adds one 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

:

Throttle type:

Route type:

DeleteIncremental type:

Example

POST /aspire/_api/policies
[{
  "type": "Throttlethrottle",
  "description": "Europe Net Appliance throttle",
  ...
}

Add multiple policies

POST /aspire_api/policies
["period": "minute",
  "value": "100"
},
{
  "type": "route",
  "description": "German servers",
  "routeTo": "US"
},
{
  "type": "deleteIncremental",
  "description": "Days before delete",
  "deletesPolicy": "AFTER_DAYS",
  "value": "1"
},
{
  "type": "ThrottledeleteIncremental",
  "description": "Iterations before delete"Europe,
 Net Appliance throttle"
  ..."deletesPolicy": "AFTER_INCREMENTALS",
  "value": "2"
},
{
  "type": "RoutedeleteIncremental",
  "description": "German server"
  ...
}default immediate policy",
  "deletesPolicy": "IMMEDIATE",
  "deleteCheckAfterErrors": "ALWAYS"
},

]

Response

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance throttle",
    "period": "minute",
    "value": "100"
   },
   {
    "id": "AAABcID5GBd=",
    "type": "route"
    ..."description": "All servers",
    "routeTo": "US"
   },
	{
    "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"
   }
]
}

Status

Delete policy(ies)

Delete one or more policies from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel
borderColor black bgColor #fafafb
DELETE /aspire/_api/policies/:id DELETE /aspire/_api/policies POST /aspire/_api/policies/delete

Path Parameters and Request Body ParametersQuery parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the policy(s) to delete

Examples

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the policy(s) to delete

ExamplesDelete a single policy

Code Block
language js theme RDark
DELETE /aspire/_api/policies/AAABcID5GBc DELETE /aspire/_api/policies?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/policies/AAABcID5GBc%3Ddelete { "ids":["AAABcID5GBc","AAABcID5GBd"] }

Response

Code Block
language js theme RDark
{ "message": "delete result response message" }

Status: 200, 404, 406

Section
Delete multiple policies, filtered Delete multiple policies from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed. Panel borderColor black bgColor #fafafb POST /aspire/_api/policies/deleteAll Common filter Response Code Block language js theme RDark { "message": "delete result response message" } Status: 200

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

GET /aspire/_api/policies/export/AAABcID5GBc

DELETE /aspire/_api/policies/export?id=AAABcID5GBc%3DAAABcID5GBc&id=AAABcIueWUc%3DAAABcID5GBd

POST /aspire/_api/policies/export
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

{
  "export": {
    "policies": {
  "message": "optional response message"
}

Status

Export multiple policies, filtered

Export 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

{
  "export": {
    "policies": {
      "policy": [
        {
          "id": "<policy_id>",
          "type": "deleteIncremental",
          "description": "pD",
          "deletesPolicy": "IMMEDIATE",
          "deleteCheckAfterErrors": "ALWAYS"
        },
        ...
      ]
    }
  }
}

Status: 200

Import

The import usage can be found here

Filters

Anchor
FiltersAnchor FiltersAnchor

Connector filter:

{  
  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"artifact" : "ARTIFACT"
  }
}