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
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single serverGet information about a single server configured in Aspire
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add serversAdd one or more servers to Aspire
Request Body Parameters
Examples Add a single server
Add multiple servers
Response
Status
|
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 Parameters
Examples Update a single server
Update multiple servers
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete serversDelete one or more servers from Aspire.
Path and Query String Parameters
Examples Delete a single server
Delete multiple servers
Response
Status
|