The servers API provides functionality that allows a administrator to perform actions such as adding and configuring a server to crawl, or beginning or stopping a crawl
Lists all the servers configured in the Aspire
GET /aspire/_api/servers
Pagination query string parameters
Lists servers configured in the Aspire, filtered by a specified criteria
Response
{ "server": [ { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": "filesystem", "description": "Local Storage", "credential": "cred_0", "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} } ], "from": 100, "size": 10, "totalItems": 10000 }
Status: 200
Get information about a single server configured in Aspire
GET /aspire/_api/servers/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the server to return |
Response
{ "server": { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4", "type": "smb", "description": "Remote Storage", "credential": "cred_1", "properties": { This is a dynamic JSON object} } }
Status: 200, 404
Add servers to Aspire
POST /aspire/_api/servers
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 |
properties | JSON | Required | Dynamic JSON object with server properties |
Example
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
{ "server": [ { "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
Update servers in Aspire.
PUT /aspire/_api/servers/:id
PUT /aspire/_api/servers
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the connector to update |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the server to update |
... |
+ fields from "Add" section...
Example
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
{ "server": [ { "id": "AAABcID5GBc", "type": "filesystem", "description": "Local Storage", "properties": { This is a dynamic JSON object} }, { "id": " "AAABcIueWUc=", "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: 200, 404, 406
Update servers configured in the Aspire, filtered by a specified criteria
PUT /aspire/_api/servers/updateAll
Response
{ "message": "update result response message" }
Status: 200, 406
Delete multiple servers from Aspire, filtered by a specified criteria
Delete one or more servers from Aspire.
DELETE /aspire/_api/servers/:id
DELETE /aspire/_api/servers
POST /aspire/_api/servers/delete
Path Parameters and Query parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the server(s) to delete |
Body Parameter
Name | Type | Required | Description |
---|---|---|---|
ids | string | Required | The identifier(s) of the server(s) to delete |
Examples
DELETE /aspire/_api/servers/AAABcID5GBc DELETE /aspire/_api/servers?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/servers/delete { "ids":["AAABcID5GBc","AAABcID5GBd"] }
Response
{ "message": "delete result response message" }
Status: 200, 404, 406
Returns the dxf for a specific server type
GET /aspire/_api/servers/type/:typeId/dxf
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
typeId | string | Required | The id of the type for which dxf is going to be retrieved |
Response
{ "dxf": {...} "message": "optional response message" }
Status: 200, 404