Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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

toc
Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Filter returned seeds to only those whose description matches the given expression
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
borderColorblack
bgColor#fafafb
GET /aspire/_api/policies

Query String Parameters

NameTypeRequiredDescription
typestringOptionalFilter returned seeds to only those with the given type
descriptionstringOptional

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
borderColorblack
bgColor#fafafb

POST /aspire/_api/policies/getAll

Pagination query string parameters

Sorting query string parameters

Common filter

Response

Code Block
languagejs
themeRDark
{
    "count": {
        "totalItems": 3
    },
    "policy": [
        {
            "id": "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
            "type": "throttle",
            "description": "throttleDesc",
            "period": "minute",
            "value": 5
        },
        {
            "id": "AAABcID5GBc=14822610-a387-44cf-a5ed-3e05618efb57",
            "type": "throttle",
            "timeUnitdescription": "mthrottleDesc",
	"numberOfDocuments            "period": "100""day",
            "value": 333
        },
        {
            "id": "AAABcIueWUc=e10af522-5830-4105-9886-3385499202ba",
            "type": "route",
            "tagsdescription": ["USroutim to cz","UK","DEU"]
  }
            "routeTo": "CZZZ"
        }
    ]
}

Status

Response codeDescription

: 200

Success




Success

: 200, 404

Section

Get

a

single policy

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

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/policies/:id


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the policy to return


Response

Code Block
languagejs
themeRDark
{
  "policyid": {
 "10653921-1b27-40b5-9d7a-f54ef1e3ad01",
   "idtype": "AAABcID5GBc=throttle",
    "typedescription": "throttlethrottleDesc",
    "timeUnitperiod": "mminute",
	  "numberOfDocumentsvalue": "100"
 }5
}

Status

Response codeDescription
200




Examples

Section

Add

policies

policy(ies)

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

Panel
borderColorblack
bgColor#fafafb
POST /aspire/_api/policies


Request Body Parameters

NameTypeRequiredDescription
typestringRequired

The type of policy to add

  • "throttle"
  • "route"
  • "deleteIncremental (5.0.2)"
descriptionstringOptionalRequiredAn optional description of the seedpolicy


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


Throttle type:

NameTypeRequiredDescription
timeUnit
periodstringRequiredTime unit of the throttling policy
numberOfDocuments
- second, minute, hour, day
valueintRequiredNumber of documents per time unit for the throttling policy


Route type:

NameTypeRequiredDescription
tags
routeTostringRequired
Tags for the routing policy
A route to tag


DeleteIncremental type:

Name TypeRequriedDescription
deletesPolicyDeletesPolicyRequired
  • 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.
deleteCheckAfterErrorsenum DeleteCheckAfterErrorsRequired 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.
valueintRequired for a variant AFTER_DAYS, AFTER_INCREMENTALSNumber of days or iterations. Valid value is also -1, that means that sends the deletes immediately since the last time the URLs were accessed.


ExampleAdd a single policy

Code Block
languagejs
themeRDark
POST /aspire/_api/policies
[{
  "type": "Throttlethrottle",
  "description": "Europe Net Appliance throttle",
  "timeUnitperiod": "mminute",
  "numberOfDocumentsvalue": "100"
}

Add multiple policies

Code Block
languagejs
POST /aspire_api/policies
[,
{
  "type": "route",
  "description": "German servers",
  "routeTo": "US"
},
{
  "type": "deleteIncremental",
  "description": "Days before delete",
  "deletesPolicy": "AFTER_DAYS",
  "value": "1"
},
{
  "type": "ThrottledeleteIncremental",
  "description": "EuropeIterations Netbefore Appliance throttledelete",
  "timeUnitdeletesPolicy": "sAFTER_INCREMENTALS",
  "numberOfDocumentsvalue": "102"
},
{
  "type": "RoutedeleteIncremental",
  "description": "Germandefault immediate serverpolicy",
  "tagsdeletesPolicy": ["USIMMEDIATE",
  "UKdeleteCheckAfterErrors",: "DEUALWAYS"]
},

]


Response

Code Block
languagejs
themeRDark
{
  "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":  "timeUnit"deleteIncremental",
    "description": "Iterations before delete",
    "deletesPolicy": "AFTER_INCREMENTALS",
    "value": "2"
   },
	{
    "id": "sAAABcID5GBg=",
    "description": "default immediate policy",
  "numberOfDocuments	"deletesPolicy": "IMMEDIATE",
  	"deleteCheckAfterErrors": "10ALWAYS"
   }
]
}

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the input

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

Status: 201, 406




Section

Update policy(ies)

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

Section

Update policies

Update a policy in Aspire.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/policies/:id

PUT /aspire/_api/policies

Path and Request Body Parameters

typedescription
NameTypeRequiredDescription
idstringRequiredThe identifier of the policy to update
descriptionstringOptionalThe type of policyxA description
periodstringOptionalAn optional description of the seed

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

Examples

xTime unit of the throttling policy - second, minute, hour, day
valueintxNumber of documents per time unit for the throttling policy, number of days or iterations for delete Incremental policy
routeTostringxA route to tag
deleteCheckAfterErrors

enum

DeleteCheckAfterErrors

xChecks 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

ExampleUpdate a single policy

Code Block
languagejs
themeRDark
PUT /aspire_api/policies/AAABcID5GBc%3D
{
  "idAAABcID5GBc=": "AAABcID5GBc=",
{
    "typeid": "throttleAAABcID5GBc=",
    "description": "Europe Net Appliance",
    "timeUnitperiod": "sminute",
    "numberOfDocumentsvalue": "10100"
}

Update multiple policies

Code Block
languagejs
PUT /aspire_api/policies
{  },
  "AAABcID5GBcAAABcID5GBd=": {
    "id": "AAABcID5GBcAAABcID5GBd=",
    "typedescription": "throttleGerman server",
    "descriptionrouteTo": "EuropeUS"
 Net Appliance"},
	"timeUnitAAABcID5GBe=": "s",{
    "numberOfDocumentsid": "10AAABcID5GBe=",
  },
  "AAABcID5GBd=description": { "default immediate policy",
    "iddeleteCheckAfterErrors": "AAABcID5GBd=","NEVER"
  },
"AAABcID5GBf=": {
    "typeid": "routeAAABcID5GBf=",
    "description": "GermanIterations before serverdelete",
    "tagsvalue": ["DEU3"]
  }
}


Response

Code Block
languagejs
themeRDark
{"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
borderColorblack
bgColor#fafafb

PUT /aspire/_api/policies/updateAll

Common filter

Update body parameter

Code Block
themeRDark
{
  "
policy
update" : 
[
{
    "
id
description" : "
AAABcID5GBc=
DESCRIPTION"
,

    "
type
period" : "
throttle
PERIOD"
    "
description
value" : "
Europe
VALUE"
   
Net
 
Appliance
"
, "timeUnit"
routeTo" : "
s
ROUTE_TO"
,

    "
numberOfDocuments
deleteCheckAfterErrors" : "
10
NEVER"
  }
]

}
Status

Response

Response
Code Block
Description
language
200
js
Success
theme
404Not found - a given seed identifier was not found
406Not acceptable - there was an issue validating the input
RDark
{
  "message": "update result response message"
}

Status: 200, 406




Section

Delete policy(ies)

Section
Delete policies

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

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/policies/:id

DELETE /aspire/_api/policies

POST /aspire/_api/policies/delete


Path Parameters and Request Body ParametersQuery parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the policy(s) to delete

Examples


Body Parameter

NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the policy(s) to delete


ExamplesDelete a single policy

Code Block
languagejs
themeRDark
DELETE /aspire/_api/policies/AAABcID5GBc%3D/AAABcID5GBc

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

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


Response

Code Block
languagejs
themeRDark
{
  "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
borderColorblack
bgColor#fafafb

POST /aspire/_api/policies/deleteAll

Common filter


Response

Code Block
languagejs
themeRDark
{
  "message": "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
borderColorblack
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

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the policy(ies) to export


Body Parameter

NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the policy(ies) to export


ExamplesDelete multiple seeds

Code Block
languagejs
themeRDark
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

Code Block
languagejs
themeRDark
{
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404Not found - a given seed identifier was not found
406
"export": {
    "policies": {
      "policy": [
        {
          "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
borderColorblack
bgColor#fafafb

POST /aspire/_api/policies/exportAll

Filters: The connection filter definition here

Response

Code Block
languagejs
themeRDark
{
  "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
languagejs
themeRDark
{  
  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"artifact" : "ARTIFACT"
  }
}