Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The servers The connections API provides functionality that allows a an administrator to perform actions such as adding and configuring a server to connection to crawl, or beginning or stopping a crawl
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get allserversconnectionsLists all the servers connections configured in the Aspire, this endpoint need the . This endpoint needs at least the OPERATOR role to be executed.
Pagination query string parameters Sorting query string parameter
Response
Status: 200 | |||||||||||||||||||||||
Section | |||||||||||||||||||||||
Get a single serverGet information about a single server configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters | |||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||
id | string | Required | The id of the server to return |
Code Block | ||
---|---|---|
| ||
{ "server": { "cn=admin,dc=accenture,dc=com", "password": "Adm1n!", "searchBase": "dc=accenture,dc=com", "iduserQuery": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4(objectClass=person)", "type": "smb", "description": "Remote Storage", "credentialgroupQuery": "cred_1(objectClass=groupOfUniqueNames)", "properties": { This is a dynamic JSON object} "userAttributes": "<users><attribute>uid</attribute><attribute>givenName</attribute></users>", } } |
Status: 200, 404
Add servers to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/servers |
Body Parameters
The type of server to add
Example
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
{ "server": [ { "userKeyAttr": "dn", "userNameAttr": "uid", "groupKeyAttr": "dn", "groupNameAttr": "ou", "groupMappingAttr": "uniqueMember", "groupsHoldMembers": "true", "userGUID": "true", "userGUIDName": "objectGUID", "isBinaryGUID": "true", "lowerCase": "false" } }, { "id": "5d0b35d598960f72-c946aab0-44e74ba1-9be5a90e-97c9ad9036a3b29d4e3c2c92", "type": "filesystem", "description": "Local StorageFs-ik", "properties": { This is a dynamic JSON object} }, { "idmultipleStartPoints": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4false", "type "url": "smbC:\\tmp\\ach1", "description": "Remote Storage", "credentialpartialScan": "cred_1false", "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.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Body Parameters
x - at least one field must be present
Example
"subDirUrl": null,
"indexContainers": "false",
"scanRecursively": "true",
"scanExcludedItems": "false",
"ignoreScanErrors": "false",
"ignoreSymLinks": "false",
"useACLs": "false",
"acls": null,
"includes": ".*test1.*",
"excludes": null
}
}
]
} |
Status: 200
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single connectionGet information about a single connection configured in Aspire. This endpoint needs at least the OPERATOR role to be executed.
Path Parameters
Response
Status: 200, 404 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connection(s)Add connections to Aspire. This endpoint needs |
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
{"response":{"credential":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}} |
Update servers configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
PUT POST /aspire/_api/ servers/updateAll |
Filters: The server filter definition here
Code Block |
---|
{
"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
Code Block | ||
---|---|---|
| ||
{
"message": "update result response message"
} |
Status: 200, 406
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple servers, filteredDelete multiple servers from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Filters: The server filter definition here Response
Status: 200 |
Body Parameters
Example
Response
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 connection(s)Update connections in Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.
Path Parameters | |||||||||||||||||||
Section | |||||||||||||||||||
Delete servers(s)Delete one or more servers from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters and Query parameters | |||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||
id | string | Required | The identifier(s) of the server(s) to delete |
Name | Type | Required | Description |
---|---|---|---|
idsid | string | Required | The identifier (s) of the server(s) to delete |
Examples
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/servers/AAABcID5GBc
DELETE /aspire/_api/servers?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/servers/delete
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
connection to update |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the connection to update |
(see add connection) | x |
x - at least one field must be present
Example
Code Block | ||||
---|---|---|---|---|
| ||||
PUT /aspire/_api/connections
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"description": "Local Storage",
"properties": { This is a dynamic JSON object}
},
"AAABcIueWUc=": {
"id": "AAABcIueWUc=",
"description": "Remote Storage",
"credential": "cred_2"
}
} |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{"server":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]} |
Status: 200, 404, 406
Section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update connections, filteredUpdate connections configured in the Aspire, filtered by a specified criteria. This endpoint needs at least the ADMINISTRATOR role to be executed.
Filters: The connection filter definition here
Response
Status: 200, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete connection(s)Delete one or more connections from Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export connection(s)Export one or more connections from Aspire. This endpoint needs at least the OPERATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section |
---|
ImportThe import usage can be found hereStatus: 200, 404, 406 |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|