The servers 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 needs at least the OPERATOR role to be executed.
Pagination query string parameters Common filterSorting query string parameter
Response
Status: 200 |
Section | |||||||
---|---|---|---|---|---|---|---|
Get information about a single server configured in Aspire
Path Parameters | |||||||
Name | Type | Required | Description | ||||
id | string | Required | The id of the server to return |
Code Block | ||
---|---|---|
| ||
{ "server": { "authentication": "simple", "user": "cn=admin,dc=accenture,dc=com", "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "typepassword": "smbAdm1n!", "description": "Remote Storage", "credentialsearchBase": "cred_1dc=accenture,dc=com", "propertiesuserQuery": { This is a dynamic JSON object} "(objectClass=person)", } } |
Status: 200, 404
Add servers to Aspire
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",
"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": [ { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "groupQuery": "(objectClass=groupOfUniqueNames)", "userAttributes": "<users><attribute>uid</attribute><attribute>givenName</attribute></users>", "userKeyAttr": "dn", "userNameAttr": "uid", "groupKeyAttr": "dn", "groupNameAttr": "ou", "groupMappingAttr": "uniqueMember", "groupsHoldMembers": "true", "typeuserGUID": "filesystemtrue", "descriptionuserGUIDName": "Local StorageobjectGUID", "properties": { This is a dynamic JSON object} }"isBinaryGUID": "true", { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "typelowerCase": "smbfalse", "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
"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
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 at least the ADMINISTRATOR role to be executed.
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
Body Parameters
x - at least one field must be present Example
Response
|
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Update server(s)Update servers in Aspire.
Path Parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the connector to update | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the server to update | ... |
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/servers
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"description": "Local Storage",
"type": "filesystem"
"properties": { This is a dynamic JSON object}
},
"AAABcIueWUc=": {
"id": "AAABcIueWUc=",
"description": "Remote Storage",
"credential": "cred_2"
"properties": { This is a dynamic JSON object}
}
} |
Response
Code Block | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
{
"server": [
{
"id": "AAABcID5GBc",
|
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 200, 404, 406
Update servers configured in the Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
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
Response
Status: 200 |
|
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
| |||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters and Query parameters
Body Parameter
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"
} |
Status: 200, 404, 406
Returns the dxf for a specific server type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/servers/type/:typeId/dxf |
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |