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 needs at least the OPERATOR role to be executed.
Query String Parameters | |||||||
Name | Type | Required | Description | xx | string | Optional |
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": { "server"totalItems": 2 }, "connection": [ { "id": "5d0b35d5f0e88016-c9461a27-44e742b6-9be5a5ae-97c9ad9036a331ab2226dbdc", "type": "ldap", "description": "LDAp-ik", "properties": { "useScript": "false", "useSearchBase": "id": "ldap-cache", "true", "server": "ldap://localhost:20389", "authentication": "simple", "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>", "userKeyAttr": "dn", "userNameAttr": "uid", "groupKeyAttr": "dn", "namegroupNameAttr": "LDAP cache" "ou", "groupMappingAttr": "uniqueMember", }, "groupsHoldMembers": "true", "descriptionuserGUID": "America LDAP", "true", "userGUIDName": "objectGUID", "createdisBinaryGUID": 1596707252548"true", "properties": { This is a dynamic JSON object } "lowerCase": "false" } }, { "id": "5d0b35d598960f72-c946aab0-44e74ba1-9be5a90e-97c9ad9036a3b29d4e3c2c92", "type": { "filesystem", "iddescription": "groupFs-expansionik", "name"properties": { "multipleStartPoints": "Group expansion service" "false", "url": "C:\\tmp\\ach1", }, "partialScan": "false", "descriptionsubDirUrl": null, "indexContainers"Group: Expansion"false", "createdscanRecursively": 1596707252548"true", "propertiesscanExcludedItems": { This is a dynamic JSON object } "false", } ]"ignoreScanErrors": "false", "from "ignoreSymLinks": 100"false", "size "useACLs": 10"false", "totalItemsacls": 10000null, "messageincludes": "optional response message" } |
Status
".*test1.*",
"excludes": null
}
}
]
} |
Status: 200
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a singleserverconnectionGet information about a single server connection configured in Aspire. This endpoint needs at least the OPERATOR role to be executed.
Path Parameters
Response
| ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | |||||||||||||||||||||
404 | The given server id was not found |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Addserversconnection(s)Add one or more servers connections to Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.
Request Body Parameters
Examples
ExampleAdd a single server
Add multiple servers
Response
Status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Update serversUpdate one or more servers in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
Request Body Path Parameters
Body Parameters
Examples
x - at least one field must be present ExampleUpdate a single server
Update multiple servers
Response
Status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given server identifier was not found | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 Delete serversDelete one or more servers from Aspire.
Path Parameters and Query parametersPath and Query String Parameters
Body Parameter
ExamplesDelete a single server
ResponseDelete multiple servers
Status: 200, 404, 406
Status
|
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