Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The policy 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

Section

List

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/policy

Query String Parameters

Name Type Required Description

type string Optional Filter returned seeds to only those with the given type

policies

Pagination query string parameters

Sorting query string parameters

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

descriptionstringOptionalFilter returned seeds to only those whose description matches the given expression

Response

Code Block

language	js
theme	RDark

{
    "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",
    ...
  }],
  "message": "optional response message"
}

Status

Response codeDescription200Success

        "value": 333
        },
        {
            "id": "e10af522-5830-4105-9886-3385499202ba",
            "type": "route",
            "description": "routim to cz",
            "routeTo": "CZZZ"
        }
    ]
}

Status: 200

: 200, 404

Section

Get single policy

Gets

Section

Get a single policy

Get 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/policy?id=:idGET /aspire_api/policypolicies/:id

Query String and Path Parameters

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

Response

Code Block

language	js
theme	RDark

{
  "policyid": {
  "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
  "idtype": "AAABcID5GBc=throttle",
    "typedescription": "throttlethrottleDesc",
    ...
 }"period": "minute",

  "messagevalue": "optional response message"5
}

Status

Response code Description

200 Success

404 The given seed id was not found

Section

Add

a

policy(ies)

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/policypolicies

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 seedpolicy

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

Examples

Add a single policy

:

Throttle type:

Name	Type	Required	Description
period	string	Required	Time unit of the throttling policy - second, minute, hour, day
value	int	Required	Number of documents per time unit for the throttling policy

Route type:

Name	Type	Required	Description
routeTo	string	Required	A route to tag

DeleteIncremental type:

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": "Throttlethrottle",
  "description": "Europe Net Appliance throttle",
  "period": "minute",
  "value": "100"
},
{
  "type": "route",
  "description": "German servers",
  "routeTo": "US"
},
{
  "type": "
  ...
}deleteIncremental",
  "description": "Days before delete",
  "deletesPolicy": "AFTER_DAYS",
  "value": "1"
},
{
  "type": "deleteIncremental",
  "description": "Iterations before delete",
  "deletesPolicy": "AFTER_INCREMENTALS",
  "value": "2"
},
{
  "type": "deleteIncremental",
  "description": "default immediate policy",
  "deletesPolicy": "IMMEDIATE",
  "deleteCheckAfterErrors": "ALWAYS"
},

]

Response

Code Block

language	js
theme	RDark

{
  "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"
   },
	{
  "message  "id": "AAABcID5GBg=",
    "description": "default immediate policy",
  	"deletesPolicy": "optional response message"
}

Status

Response code Description

201 Created

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

406Not acceptable - there was an issue validating the input

Not acceptable - there was an issue validating the input

Section

Update

a

policy(ies)

Update 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 nullpolicies in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/

policy

policies/:id

PUT /aspire/_api/policies

Request Body Parameters

typedescription

Name	Type	Required	Description
id	string	Required	The identifier of the policy to update
description	string	Required	The type of policy	x	A description
period	string	Optional	An optional description of the seed

Other parameters passed in the request body will depend on the type of policy being created - see Policy API above

Examples

Update a single policy

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 present

Example

Code Block

language	js
theme	RDark

PUT /aspire_api/policies
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "type"description": "Europe Net Appliance",
    "period": "minute",
    "value": "100"
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "description": "German server",
    "routeTo": "US"
  },
"AAABcID5GBe=": {
    "id": "AAABcID5GBe=",
    "description": "default immediate policy",
    "deleteCheckAfterErrors": "NEVER"
  },
"AAABcID5GBf=": {
    "id": "throttleAAABcID5GBf=",
    "description": "EuropeIterations Netbefore Appliancedelete",
    ...
"value": "3"
 }

Response

Code Block

language	js
theme	RDark

{"policy":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"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

{
  "

policy

update" : {
    "

id

description" : "

AAABcID5GBc=

DESCRIPTION"

,

type

period" : "

throttle

PERIOD"
    "

description

value" : "

Europe Net Appliance

VALUE"
    "routeTo" : "ROUTE_TO"

...

"deleteCheckAfterErrors" : "NEVER"

},

}
}

Response

Code Block

language	js
theme	RDark

{
  "message": "

optional

update result response message"
}

Status

Response code Description

201 Created

404 Not found - a given seed identifier was not found

406

: 200, 406

Section

Delete policy(

s

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/policy?id=:id

DELETE /aspire/_api/policy/:idpolicies

POST DELETE /aspire/_api/policypolicies/delete

Path Parameters and Query parametersQuery String, Path and Request Body 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/delete
{
  "idids": ["AAABcID5GBc=","AAABcID5GBd"]
}

Delete multiple seedsResponse

Code Block

language	js
theme	RDark

[{
  "idmessage": "AAABcID5GBc=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

{
  "

id

message": "

AAABcIueWUc=" }]

Delete multiple policies (alternative form)

delete result response message"
}

Status: 200

Not acceptable - there was an issue validating the input

Section

Export policy(ies)

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

Panel

borderColor	black
bgColor	#fafafb

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 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 export

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/policies/export/AAABcID5GBc

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

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

Code Block

language	js

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "policies": {
      "policy": [
        {
          "id": "<policy_id>",
          "type": "deleteIncremental",
          "description": "pD",
          "messagedeletesPolicy": "optional response message"
}

Status

Response code Description

200 Success

404 Not found - a given seed identifier was not found

406

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

Connector filter:

Code Block

language	js
theme	RDark

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

Page tree

Versions Compared

Old Version 3

New Version Current

Key

Get all policies

Get all policies, filtered

Get single policy

Get a single policy

Add

policy(ies)

Update

policy(ies)

Update policies, filtered

Delete policy(

ies)

Delete multiple policies, filtered

Export policy(ies)

Export multiple policies, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 3

New Version Current

Key

Get all policies

Get all policies, filtered

Get single policy

Get a single policy

Add

policy(ies)

Update

policy(ies)

Update policies, filtered

Delete policy(

ies)

Delete multiple policies, filtered

Export policy(ies)

Export multiple policies, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor