List policies

Lists all the policies configured in the Aspire

Query String Parameters

Response

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "filesystemthrottle",
    ...
  },
  {
    "id": "AAABcIueWUc=",
    "type": "filesystemexecution",
    ...
  }],
  "message": "optional response message"
}

Status

Get a single policy

Get information about a single policy configured in Aspire

Query String and Path Parameters

Response

{
  "policy": {
    "id": "AAABcID5GBc=",
    "type": "filesystemthrottle",
    ...
 },

  "message": "optional response message"
}

Status

Add a policy

Add Adds one or more policies policy to Aspire

Panel
borderColor black bgColor #fafafb
POST /aspire_api/policy

Request Body Parameters

Name	Type	Required	Description
type	string	Required	The type of connector to use for this seed (may be omitted if connector is specified)policy to add
description	string	Optional	An optional description of the seed

Other parameters passed in the request body will depend on the type of policy being created - those required by Documentum will be different from those required by SharePoint. Some candidates are shown below

{
  "type": "filesystemThrottle"
  "description": "Europe Net Appliance"
  ...
}

{
  "policy": [{
    "id": "AAABcID5GBc=",
    "type": "filesystemthrottle"
    "description": "Europe Net Appliance"
    ...
   },
   {
    "id": "AAABcIueWUc=",
    "type": "sharepoint"
    "description": "SP Online"
    ...
  }],
  "message": "optional response message"
}

Update a policy

Update one or more a policys 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

Panel
borderColor black bgColor #fafafb
PUT /aspire_api/policy

Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the seed policy to update
type	string	Required	The type of connector to use for this seed (may be omitted if connector is specified)policy
description	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 Add policy(s) Policy API above

Examples

Update a single policy

Code Block
language js
{ "id": "AAABcID5GBc=", "type": "filesystemthrottle" "description": "Europe Net Appliance" ... }

Update multiple policies

js

Code Block
language
[{ "id": "AAABcID5GBc=", "type": "filesystem" "description": "Europe Net Appliance" ... }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" ... }]

Response

Code Block
language js
{ "policy": [{ "id": "AAABcID5GBc=", "type": "filesystemthrottle" "description": "Europe Net Appliance" ... }, { "id": "AAABcIueWUc=", "type": "sharepoint" "description": "SP Online" ... }], "message": "optional response message" }

Status

Response code	Description
201	Created
404	Not found - a given seed identifier was not found
406	Not acceptable - there was an issue validating the input

Delete policy(s)

Delete one or more policies from Aspire.

Query String, Path and Request Body Parameters

Examples

Delete a single policy

{
  "id": "AAABcID5GBc="
}

Delete multiple seeds

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

Delete multiple policies (alternative form)

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

Response

{
  "message": "optional response message"
}

Status