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": {"simple", "user": "cn=admin,dc=accenture,dc=com", "password": "Adm1n!", "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "typesearchBase": "smbdc=accenture,dc=com", "description": "Remote Storage", "credentialuserQuery": "cred_1(objectClass=person)", "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.
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": [ { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": "filesystem","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", "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
Update servers in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Note |
---|
The existing document will be replaced by the new one provided in the body |
Path Parameters
Body Parameters
+ fields from "Add" section...
Example
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", "type": "filesystem","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", "descriptionuseACLs": "Local Storagefalse", "properties": { This is a dynamic JSON object} "acls": }null, { "id": " "AAABcIueWUc=", "typeincludes": "smb.*test1.*", "description": "Remote Storage", "credentialexcludes": "cred_1",null "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: 200, 404, 406
Status: 200
Section | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single connectionGet information about a single connection configured in Aspire. This endpoint needs at least the OPERATOR Update servers, filteredUpdate servers configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Response
Status: 200, 406
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connection(s)Add connections to Aspire. This endpoint needs | |||||||||||||||||||||||||||||||||||||||||||||||
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.
Response
Status: 200 | |||||||||||||||||||||||||||||||||||||||||||||||
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
connections |
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 |
deleteIncrementalPolicy | string | Optional | Delete policy id |
throttlePolicy | string | Optional | Throttle policy id |
routingPolicies | string array | Optional | Routing policies ids |
properties | JSON | Required | Dynamic JSON object with server properties |
Example
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/connections
[{
"type": "filesystem",
"description": "Local storage",
"deleteIncrementalPolicy": "deletePolicyId",
"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 | ||||
---|---|---|---|---|
| ||||
{
"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.
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 |
---|
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 | |||||||||||||
Get server type dxf (TODO)Returns the dxf for a specific server type
Path Parameters | |||||||||||||
Name | Type | Required | Description | ||||||||||
typeId | string | Required | The id of the type for which dxf is going to be retrieved |
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |