Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
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
| |||||||||||||||||||||
Response code | Description | ||||||||||||||||||||
200 | Success |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all servers, filteredLists servers configured in the Aspire, filtered by a specified criteria
|
: 200 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get | ||||||||||||||||||||
Section | ||||||||||||||||||||
Get a single serverGet information about a single server configured in Aspire
Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | |||||||||||||||||||
404 | The given server id was not found |
Section | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Addserversserver(s)Add servers to Aspire
Body Parameters
Example
Response
Status | |||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||
201 | Created | 406 | Not acceptable - there was an issue validating the input
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Updateserversserver(s)Update servers in Aspire.
Path Body 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
| ||||||||||
201 | Created | |||||||||
404 | Not found - a given server identifier was not found | 406 | Not acceptable - there was an issue validating the input
| |
{
"message": "update result response message"
} |
Status: 200, 406
Section | |||||||
---|---|---|---|---|---|---|---|
Delete multiple servers, filteredDelete multiple servers from Aspire, filtered by a specified criteria
Body Parameters | |||||||
Name | Type | Required | Description | ||||
filter | JSON | Required | Filters retrieved servers. Check the filter definition here |
Code Block | ||
---|---|---|
| ||
{ "message": "optional response message" } |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Status: 200
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete servers(s)Delete one or more servers Delete single serverDelete a single server from Aspire.
Path Parameters and Query parameters
Body Parameter
ExampleExamples
Response
| |||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get server type dxf (TODO)Returns the dxf for a specific server type
Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | 404 | Not found - a given service identifier was not found