The policies API provides functionality that allows a administrator to add, delete or update policies

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Pagination query string parameters

Sorting query string parameters

Section

Get all policies

Lists all the policies configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/policies

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

"asc" for ascending sort,
"desc" for descending sort

Section

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.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies/getAll

Pagination query string parameters

Sorting query string parameters

Common filter

Response

Code Block

language	js
theme	RDark

{
    "policycount": [{
    "id": "AAABcID5GBc=",
    "typetotalItems": "throttle",
	"description": "Europe Net Appliance throttle"3
    },
    "timeUnitpolicy": "m",
	"timeUnitRate": "1",
	"numberOfDocuments": "100"
  },
[
        {
            "id": "AAABcIueWUc=10653921-1b27-40b5-9d7a-f54ef1e3ad01",
            "type": "routethrottle",
	            "description": "All serversthrottleDesc",
            "tagsperiod": ["USminute","UK","DEU"]
  }]
}

Status

Response codeDescription200Success Section

Get all policies, filtered

Lists policies configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies/getAll

Query String Parameters

NameTypeRequiredDescriptionfromintegerOptionalIndicates the initial page to be retrievedsizeintegerOptionalSpecifies the size of results pagesortBystringOptionalField by which results are sortedsortModestringOptional

Sort mode

"asc" for ascending sort,
"desc" for descending sort

Body Parameters

NameTypeRequiredDescriptionfilterJSONRequiredFilters retrieved policies. Check the filter definition here

Response

Code Block

language	js

{  
  "policy": [
            "value": 5
        },
        {
            "id": "AAABcID5GBc=14822610-a387-44cf-a5ed-3e05618efb57",
            "type": "throttle",
	"description": "Europe Net Appliance throttle",
            "timeUnitdescription": "mthrottleDesc",
	"timeUnitRate            "period": "1day",
	"numberOfDocuments            "value": "100"
333
        },
        {
            "id": "AAABcIueWUc=e10af522-5830-4105-9886-3385499202ba",
            "type": "route",
	            "description": "Allroutim to serverscz",
     "tags       "routeTo": ["US","UK","DEU"]"CZZZ"
        }
    ]
}

Status

Response codeDescription200Success

: 200

: 200, 404

Section

Get single policy

Gets information about a single policy configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/policies/:id

Query String Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the policy to return

Response

Code Block

language	js
theme	RDark

{
  "policy": {
    "id": "AAABcID5GBc=10653921-1b27-40b5-9d7a-f54ef1e3ad01",
    "type": "throttle",
	  "description": "Europe Net Appliance throttlethrottleDesc",
    "timeUnitperiod": "mminute",
	"timeUnitRate":  "1",
	"numberOfDocumentsvalue": "100"5
 }
}

Status

Response code Description

200 Success

See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors

Status: 201, 406

Not acceptable - there was an issue validating the input

Section

Add

policies

policy(ies)

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies

Request Body Parameters

Name

Type

Required

Description

type

string

Required

The type of policy to add

"throttle"
"route"
"deleteIncremental (5.0.2)"

description

string

OptionalRequired

An optional description of the policy

Other parameters passed in the request body will depend on the type of policy being created:

Throttle type:

Name	Type	Required	Description
timeUnitperiod	string	Required	Time unit of the throttling policy
timeUnitRate	int	Required	The rate at which each time unit is throttled
- second, minute, hour, day
value	numberOfDocuments	int	Required	Number of documents per time unit for the throttling policy

Route type:

Name	Type	Required	Description	tags	array of strings	Required
routeTo	string	Required	A route to tag

DeleteIncremental type:

Tags for the routing policy

Name

Type

Requried

Description

deletesPolicy

DeletesPolicy

Required

IMMEDIATE - policy will be processed immediately, also is taken to consideration, if should be done after errors (property deleteCheckAfterError).
AFTER_DAYS - policy will be processed after number of days, number of days are stored in property value.
AFTER_INCREMENTALS - policy will be processed after number of incrementals, number of incrementals are stored in property value.

deleteCheckAfterErrors

enum DeleteCheckAfterErrors

Required for a variant IMMEDIATE

Checks if "delete" candidates still exist after an incremental when they are part of scan error.

ALWAYS - policy will be processed even if errors are found.
NEVER - policy will be not processed when errors are found.

value

int

Required for a variant AFTER_DAYS, AFTER_INCREMENTALS

Number of days or iterations. Valid value is also -1, that means that sends the deletes immediately since the last time the URLs were accessed.

Example

Code Block

language	js
theme	RDark

POST /aspire_api/policies
[{
  "type": "throttle",
  "description": "Europe Net Appliance throttle",
  "period": "minute",
  "value": "100"
},
{
  "type": "route",
  "description": "German servers",
  "routeTo": "US"
},
{
  "type": "deleteIncremental",
  "timeUnitdescription": "sDays before delete",
  "timeUnitRatedeletesPolicy": "10AFTER_DAYS",
  "numberOfDocumentsvalue": "101"
},
{
  "type": "routedeleteIncremental",
  "description": "German serversIterations before delete",
  "deletesPolicy": "AFTER_INCREMENTALS",
  "value": "2"
},
{
  "type": "deleteIncremental",
  "tagsdescription": ["USdefault immediate policy","UK","DEU"]
}
  "deletesPolicy": "IMMEDIATE",
  "deleteCheckAfterErrors": "ALWAYS"
},

]

Response

Code Block

language	js
theme	RDark

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "throttle"
    "description": "Europe Net Appliance throttle",
    "timeUnit"period": "minute",
    "value": "s100"
   },
   {
    "timeUnitRateid": "10AAABcID5GBd=",
    "numberOfDocumentstype": "10route"
    },"description": "All servers",
    "routeTo": "US"
   },
	{
    "id": "AAABcID5GBd=AAABcID5GBe=",
    "type": "deleteIncremental",
  	"description": "Days before delete",
  	"deletesPolicy": "AFTER_DAYS",
  	"value": "1"
   },
	{
    "id": "AAABcID5GBf=",
    "type": "routedeleteIncremental",
    "description": "Iterations before delete",
    "deletesPolicy": "All servers",
    "tags": ["US","UK","DEU"]"AFTER_INCREMENTALS",
    "value": "2"
   },
	{
    "id": "AAABcID5GBg=",
    "description": "default immediate policy",
  	"deletesPolicy": "IMMEDIATE",
  	"deleteCheckAfterErrors": "ALWAYS"
   }
]
}

Status

Response code Description

201 Created

406

Section

Update

policies

policy(ies)

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/policies/:id

PUT /aspire/_api/policies

Body Parameters

typedescription

Name	Type	Required	Description
id	string	Required	The identifier of the policy to update
description	string	Optional	The type of policy	x	A description
period	string	Optional	An optional description of the seed	x	Time unit of the throttling policy - second, minute, hour, day
value	int	x	Number of documents per time unit for the throttling policy, number of days or iterations for delete Incremental policy
routeTo	string	x	A route to tag
deleteCheckAfterErrors	enum DeleteCheckAfterErrors	x	Checks if "delete" candidates still exist after an incremental when they are part of scan error. (ALWAYS/NEVER)

x - at least one field must be presentOther parameters passed in the request body will depend on the type of policy being created - see Add a Policy above

Example

Code Block

language	js
theme	RDark

PUT /aspire_api/policies
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "typedescription": "throttleEurope Net Appliance",
    "descriptionperiod": "Europe Net Appliance",
	"timeUnit"minute",
    "value": "100"
  },
  "AAABcID5GBd=": {
    "id": "sAAABcID5GBd=",
    "timeUnitRatedescription": "1German server",
    "numberOfDocumentsrouteTo": "10US"
  },
  "AAABcID5GBdAAABcID5GBe=": {
    "id": "AAABcID5GBdAAABcID5GBe=",
    "typedescription": "routedefault immediate policy",
    "description": "German server"deleteCheckAfterErrors": "NEVER"
  },
"AAABcID5GBf=": {
    "id": "AAABcID5GBf=",
    "tagsdescription": ["DEU"]
  }
Iterations before delete",
    "value": "3"
 }

Response

Code Block

language	js
theme	RDark

{{
  "policy": [{
    "updated":true,"id": "AAABcID5GBc="},
    "type{"updated": true,"throttle"
    "description": "Europe Net Appliance",
	"timeUnit": "s",
	"timeUnitRate": "1",
    "numberOfDocuments": "10"
   },
   {id":"AAABcID5GBd="},{"updated":true,"id":"AAABcID5GBe="},{"updated":true,"id":"AAABcID5GBf="}]}

Status: 200, 404, 406

Section

Update policies, filtered

Update policies configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/policies/updateAll

Common filter

Update body parameter

Code Block

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION"
    "

id

period" : "

AAABcID5GBd=

PERIOD"

,

type

value" : "

route

VALUE"
    "

description

routeTo" : "

German server",

ROUTE_TO"
    "

Delete policy(ies)

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

Delete multiple policies, filtered

Delete multiple policies from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/policies/:id

DELETE /aspire/_api/policies

POST /aspire/_api/policies/deleteAlldelete

Path Parameters and Query parameters

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

Body ParameterBody Parameters

Name	Type	Required	Description
filterids	JSONstring	RequiredFilters retrieved credentials. Check the filter definition here	The identifier(s) of the policy(s) to delete

Examples

Code Block

language	js
theme	RDark

DELETE /aspire/_api/policies/AAABcID5GBc

DELETE /aspire/_api/policies?id=AAABcID5GBc&id=AAABcID5GBd

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

Response

Code Block

language	js
theme	RDark

{
  "message": "optionaldelete result response message"
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

Response code Description

200 Success

404 Not found - a given credential identifier was not found

406 Not acceptable - there was an issue validating the input

Section

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

Section

Export policy(ies)

Export one or more policy from Aspire, this endpoint needs at least the OPERATOR role to be executed

Delete policy

Delete a single policy from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE GET /aspire/_api/policies/export

GET /aspire/_api/policies/export/:id

POST /aspire/_api/policies/exportAll

Info

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Note
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Note
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

Path Parameters and Query parametersQuery String Parameters

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

Body Parameter

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

ExampleExamples

Code Block

language	js
theme	RDark

GET /aspire/_api/policies/export/AAABcID5GBc

DELETE /aspire/_api/policies/AAABcID5GBc%3D

Delete multiple policies

/export?id=AAABcID5GBc&id=AAABcID5GBd

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

Response

Code Block

language	js
theme	RDark

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

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

       "id": "<policy_id>",
          "type": "deleteIncremental",
          "description": "pD",
          "deletesPolicy": "IMMEDIATE",
          "deleteCheckAfterErrors": "ALWAYS"
        },
        ...
      ]
    }
  }
}

Status: 200, 404, 406

Section

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.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policies/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

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

Status: 200

Section

Import

The import usage can be found here

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Credentials filter:

Connector filter:

Code Block

language	js
theme	RDark

{  
  "filter" : {
    "ids" : ["id1ID1", "id2ID2", "id3ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"artifact" : "ARTIFACT"
  }

Note

When using delete endpoints, ids in the filter are mandatory.

Page tree

Versions Compared

Old Version 18

New Version Current

Key

Get all policies

Get all policies, filtered

Get all policies, filtered

Get single policy

Add

policy(ies)

Update

policy(ies)

Update policies, filtered

Delete policy(ies)

Delete multiple policies, filtered

Delete multiple policies, filtered

Export policy(ies)

Delete policy

Export multiple policies, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 18

New Version Current

Key

Get all policies

Get all policies, filtered

Get all policies, filtered

Get single policy

Add

policy(ies)

Update

policy(ies)

Update policies, filtered

Delete policy(ies)

Delete multiple policies, filtered

Delete multiple policies, filtered

Export policy(ies)

Delete policy

Export multiple policies, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor