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", "createdtype": 1596707252548"ldap", "updateddescription": 1596707252548"LDAp-ik", "properties": { This is a dynamic JSON object} }, { "iduseScript": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4false", "type "useSearchBase": "smbtrue", "description": "Remote Storage", "createdserver": 1596707252548, "updated": 1596707252548, "credential": "cred_1", "ldap://localhost:20389", "propertiesauthentication": {"simple", This is a dynamic JSON object} } ], "from": 100, "sizeuser": 10"cn=admin,dc=accenture,dc=com", "sortBy "password": "idAdm1n!", "sortMode": "asc" "totalItems": 10000, "messagesearchBase": "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": [ { 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", "idgroupNameAttr": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", ou", "typegroupMappingAttr": "filesystemuniqueMember", "descriptiongroupsHoldMembers": "Local Storagetrue", "created": 1596707252548, "updated": 1596707252548, "propertiesuserGUID": {"true", This is a dynamic JSON object} }, { "iduserGUIDName": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4objectGUID", "type "isBinaryGUID": "smbtrue", "description": "Remote Storage", "createdlowerCase": 1596707252548, "false" "updated": 1596707252548, "credential": "cred_1", } "properties": { This is a dynamic JSON object}, }{ ], "from": 100, "size": 10, "sortByid": "id98960f72-aab0-4ba1-a90e-b29d4e3c2c92", "sortModetype": "ascfilesystem", "totalItems "description": 10000"Fs-ik", "messageproperties": "optional response message" } |
Status
Get information about a single server configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "server": { { "multipleStartPoints": "false", "url": "C:\\tmp\\ach1", "idpartialScan": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4false", "type": "smb", "descriptionsubDirUrl": "Remote Storage"null, "created": 1596707252548, "updated": 1596707252548, "credentialindexContainers": "cred_1false", "properties": { This is a dynamic JSON object} }, "message"scanRecursively": "true", "scanExcludedItems": "optional response message" } |
Status
"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
| ||||||||||||||||||||||
Section | ||||||||||||||||||||||
Add serversAdd servers to Aspire
Body Parameters | ||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||
type | string | Required | The type of server to add | |||||||||||||||||||
description | string | Required | An optional description of the server | |||||||||||||||||||
credentials | string | Optional | Credentials can be specified for the server | |||||||||||||||||||
properties | JSON | Required | Dynamic JSON object with server properties (from dxf) |
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-97c9ad9036a397c9ad9036a4", "type": "filesystemsmb", "description": "LocalRemote Storage", "createdcredential": 1596707252548, "updated": 1596707252548cred_1", "properties": { This is a dynamic JSON object} }, { "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, 404
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connection(s)Add connections to Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.
Body Parameters
Example
Update serversUpdate servers in Aspire.
Body Parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the server to update | ||||||||||||||||||||||||||||||||||||||||||||||||||
type | 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) |
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/servers { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "description": "Local Storage", "type": "filesystem" }, "AAABcIueWUc=": { "id": "AAABcIueWUc=", "description": "Remote Storage", "credential": "cred_21", "properties": { This will be a dynamic JSON object } }] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "serverconnection": [ { "id": "AAABcID5GBc5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": "filesystem", "description": "Local Storage", "createdproperties": 1596707252548, "updated": 1596707252548, "properties": { This is a dynamic JSON object} { This is a dynamic JSON object} }, { "id": " "AAABcIueWUc=5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "type": "smb", "description": "Remote Storage", "createdcredential": 1596707252548"cred_1", "updatedproperties": 1596707252548, "credential": "cred_1", "properties": { { This is a dynamic JSON object} } ] } |
Status
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.
Delete multiple servers, filteredDelete multiple servers from Aspire, filtered by a specified criteria
Body Path Parameters
Response
Body Parameters
x - at least one field must be present Example
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status | |||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||
---|---|---|---|---|
| ||||
|
Query String Parameters
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/servers/AAABcID5GBc%3D |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
{
"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 |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
| |||||||||||||
Response code | Description | ||||||||||||
200 | Success | ||||||||||||
404 | Not found - a given server identifier was not found | ||||||||||||
406 | Not acceptable - there was an issue validating the input | ||||||||||||
Section | |||||||||||||
Filters Anchor | | FiltersAnchor | FiltersAnchor |
Code Block | ||
---|---|---|
| ||
"filter" : {
"ids" : ["ID1", "ID2", "ID3", ...],
"type" : "TYPE",
"description" : "DESCRIPTION"
}
|
Note |
---|
When using delete endpoints, ids in the filter are mandatory. |