The configuration and control API provides functionality that allows a administrator to perform actions such as adding a seed to crawl, or beginning or stopping a crawl. This API will provide the functionality required by the Aspire User interface and will be extensively used by it. The API will also be used by any external process (or script) that needs to control Aspire
Table of Contents |
---|
Section | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List seedsLists all the seeds configured in the Aspire
Parameters
Response
Status
|
Section | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single seedGet information about a single seed configured in Aspire
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seed(s)Add one or more seeds to Aspire
ParametersRequest Body Objects
Examples Add a single seed
Add multiple seeds
Add multiple seedsResponse
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update seed(s)Update one or more seeds 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 Objects
Examples Update a single seed
Update multiple seeds
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete seed(s)Delete one or more seeds from Aspire.
Request Body Objects
Examples Delete a single seed
Update multiple seeds
Update multiple seeds (alternative form)
Response
Status
|