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.
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
from | integer | Optional | Indicates the initial page to be retrieved | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy | string | Optional | Field by which results are sorted | ||||
sortMode | string | Optional | Sort mode
| ||||
expand | string | Optional | List of fields to expand, * will expand everything |
connections |
Pagination query string parameters
Sorting query string parameter
Section | |||||||
---|---|---|---|---|---|---|---|
Get all connections, filteredLists connections configured in the Aspire, filtered by a specified criteria. This endpoint needs at least the OPERATOR role to be executed.
Pagination query string parameters |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"count": {
"totalItems": 2
},
"connection": [
{
|
Response
Code Block | ||
---|---|---|
| ||
{ "server": [ { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": "filesystem", "descriptionid": "Local Storagef0e88016-1a27-42b6-a5ae-31ab2226dbdc", "created": 1596707252548, "updatedtype": 1596707252548"ldap", "properties": { This is a dynamic JSON object}"description": "LDAp-ik", }, { "idproperties": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", { "type": "smb", "descriptionuseScript": "Remote Storagefalse", "created": 1596707252548, "updated": 1596707252548, "credentialuseSearchBase": "cred_1true", "properties": { This is a dynamic JSON object} "server": "ldap://localhost:20389", } ], "from": 100, "size": 10, "sortByauthentication": "idsimple", "sortMode": "asc" "totalItems": 10000, "message": "optional response message" } |
Status
Lists servers configured in the Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String Parameters
Sort mode
Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "server": [ { "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>", "iduserKeyAttr": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3dn", "type": "filesystem "userNameAttr": "uid", "descriptiongroupKeyAttr": "Local Storagedn", "created": 1596707252548, "updated": 1596707252548, "propertiesgroupNameAttr": {"ou", This is a dynamic JSON object} }, { "id"groupMappingAttr": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4uniqueMember", "type": "smb", "descriptiongroupsHoldMembers": "Remote Storagetrue", "created": 1596707252548, "updated": 1596707252548, "credentialuserGUID": "cred_1true", "properties": { This is a dynamic JSON object} "userGUIDName": "objectGUID", } ], "from": 100, "size": 10, "sortByisBinaryGUID": "idtrue", "sortMode": "asc" "totalItems": 10000, "message "lowerCase": "optional response message" } |
Status
Get information about a single server configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "server": { "false" } }, { "id": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92", "idtype": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4filesystem", "type": "smb", "description": "Remote StorageFs-ik", "created": 1596707252548, "updated": 1596707252548, "credentialproperties": "cred_1",{ "properties "multipleStartPoints": { This is a dynamic JSON object} "false", }, "messageurl": "optional response message" } |
Status
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"C:\\tmp\\ach1", "partialScan": "false", "subDirUrl": null, "indexContainers": "false", "scanRecursively": "true", "scanExcludedItems": "false", "ignoreScanErrors": "false", "ignoreSymLinks": "false", "useACLs": "false", "type": "filesystem", "acls": null, "description": "Local Storage", "createdincludes": 1596707252548".*test1.*", "updated": 1596707252548, "properties": { This is a dynamic JSON object}"excludes": null }, { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", } "type": "smb", } "description": "Remote Storage", "created": 1596707252548, "updated": 1596707252548, "credential": "cred_1", "properties": { This is a dynamic JSON object} } ] } |
Status
]
} |
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.
Update serversUpdate servers in Aspire.
Body Path Parameters
Response string
| Optional | The type of server to add | ||||||||||||||||||||||
description | string | Optional | An optional description of the server | |||||||||||||||||||||
credentials | string | Optional | Credentials can be specified for the server | |||||||||||||||||||||
properties | JSON | Optional | Dynamic JSON object with server properties (from dxf) |
|
Example
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/servers { "AAABcID5GBc=connection": { "id": "AAABcID5GBc=5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "descriptiontype": "Local Storagesmb", "typedescription": "filesystem" }Remote Storage", "AAABcIueWUc=credential": {"cred_1", "idproperties": "AAABcIueWUc=", "description": "Remote Storage",{ This is a dynamic JSON object} "credential": "cred_2" } } |
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
StatusResponse Response
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given server identifier was not found | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
| |
{
"connection": [
{
"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
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update connection(s)Update connections in Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed. | ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | |||||||||||||||||||
404 | Not found - a given credential identifier was not found | |||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/servers/AAABcID5GBc%3D |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Returns the dxf for a specific server type
Panel | ||||
---|---|---|---|---|
| ||||
GET
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
typeIdid | string | Required | The id identifier of the type for which dxf is going to be retrieved |
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status
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 here | 404 | Not found - a given service identifier was not found
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials Seed filter:
|