The servers API provides functionality that allows a administrator to perform actions such as adding and configuring a server to crawl, or beginning or stopping a crawl
Lists all the servers configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
GET /aspire/_api/servers
Pagination query string parameters
Lists servers configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
POST /aspire/_api/servers/getAll
Response
{ "count": { "totalItems": 2 }, "server": [ { "id": "f0e88016-1a27-42b6-a5ae-31ab2226dbdc", "type": "ldap", "description": "LDAp-ik", "properties": { "useScript": "false", "useSearchBase": "true", "server": "ldap://localhost:20389", "authentication": "simple", "user": "cn=admin,dc=accenture,dc=com", "password": "Adm1n!", "searchBase": "dc=accenture,dc=com", "userQuery": "(objectClass=person)", "groupQuery": "(objectClass=groupOfUniqueNames)", "userAttributes": "<users><attribute>uid</attribute><attribute>givenName</attribute></users>", "userKeyAttr": "dn", "userNameAttr": "uid", "groupKeyAttr": "dn", "groupNameAttr": "ou", "groupMappingAttr": "uniqueMember", "groupsHoldMembers": "true", "userGUID": "true", "userGUIDName": "objectGUID", "isBinaryGUID": "true", "lowerCase": "false" } }, { "id": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92", "type": "filesystem", "description": "Fs-ik", "properties": { "multipleStartPoints": "false", "url": "C:\\tmp\\ach1", "partialScan": "false", "subDirUrl": null, "indexContainers": "false", "scanRecursively": "true", "scanExcludedItems": "false", "ignoreScanErrors": "false", "ignoreSymLinks": "false", "useACLs": "false", "acls": null, "includes": ".*test1.*", "excludes": null } } ] }
Status: 200
Get information about a single server configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
GET /aspire/_api/servers/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the server to return |
Response
{ "server": { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "type": "smb", "description": "Remote Storage", "credential": "cred_1", "properties": { This is a dynamic JSON object} } }
Status: 200, 404
Add servers to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
POST /aspire/_api/servers
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of server to add |
description | string | Required | An optional description of the server |
credential | string | Optional | Credential id can be specified for the server |
throttlePolicy | string | Optional | Throttle policy id |
routingPolicies | string array | Optional | Routing policies ids |
properties | JSON | Required | Dynamic JSON object with server properties |
Example
POST /aspire/_api/servers [{ "type": "filesystem", "description": "Local storage", "throttlePolicy": "throttlePolicyId", "routingPolicies": ["routingPolicyId1", "routingPolicyId2"], "properties": { This will be a dynamic JSON object } }, { "type": "filesystem", "description": "Remote Storage", "credential": "cred_1", "properties": { This will be a dynamic JSON object } }]
Response
{ "server": [ { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": "filesystem", "description": "Local Storage", "properties": { This is a dynamic JSON object} }, { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "type": "smb", "description": "Remote Storage", "credential": "cred_1", "properties": { This is a dynamic JSON object} } ] }
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 201, 406
Update servers in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
PUT /aspire/_api/servers/:id
PUT /aspire/_api/servers
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the connector to update |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the server to update |
description | string | x | A description |
credential | string | x | Credential id can be specified for the server |
throttlePolicy | string | x | Throttle policy id |
routingPolicies | string array | x | Routing policies ids |
properties | JSON | x | Dynamic JSON object with server properties |
x - at least one field must be present
Example
PUT /aspire/_api/servers { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "description": "Local Storage", "properties": { This is a dynamic JSON object} }, "AAABcIueWUc=": { "id": "AAABcIueWUc=", "description": "Remote Storage", "credential": "cred_2" } }
Response
{"server":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}
Status: 200, 404, 406
Update servers configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
PUT /aspire/_api/servers/updateAll
Filters: The server filter definition here
{ "update" : { "description" : "DESCRIPTION" "credential" : "credentialId", "throttlePolicy" : "throttlePolicyId", "properties" : {}, "routingPolicies" : ["RP_ID1", "RP_ID2", "RP_ID3", ...] "routingPolicies.add" : ["RP_ID1", "RP_ID2", "RP_ID3", ...] "routingPolicies.remove" : ["RP_ID1", "RP_ID2", "RP_ID3", ...] } }
Response
{ "message": "update result response message" }
Status: 200, 406
Delete multiple servers from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Delete one or more servers from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
DELETE /aspire/_api/servers/:id
DELETE /aspire/_api/servers
POST /aspire/_api/servers/delete
Path Parameters and Query parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the server(s) to delete |
Body Parameter
Name | Type | Required | Description |
---|---|---|---|
ids | string | Required | The identifier(s) of the server(s) to delete |
Examples
DELETE /aspire/_api/servers/AAABcID5GBc DELETE /aspire/_api/servers?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/servers/delete { "ids":["AAABcID5GBc","AAABcID5GBd"] }
Response
{ "message": "delete result response message" }
Status: 200, 404, 406
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Seed filter:
"filter" : { "ids" : ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "credentials" : "credentialId", "throttlePolicy" : "throttlePolicyId", "routingPolicies" : ["RP1", "RP2", "RP3", ...] }