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
Table of Contents |
---|
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all serversLists all the servers configured in the Aspire
Pagination query string parameters
Response
Status: 200 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get information about a single server configured in Aspire
Path Parameters
Response
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add server(s)Add servers to Aspire
Body Parameters
Example
Response
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 server(s)Update servers in Aspire.
Path Parameters
Body Parameters
+ fields from "Add" section... Example
Response
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 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Update servers, filteredUpdate servers configured in the Aspire, filtered by a specified criteria
Response
Status: 200, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple servers, filteredDelete multiple servers from Aspire, filtered by a specified criteria
Response
Status: 200 |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete servers(s)Delete one or more servers from Aspire.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get server type dxf (TODO)Returns the dxf for a specific server type
Path Parameters
Response
Status: 200, 404 |