Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectors
Table of Contents |
---|
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List connectorsLists all the seeds connectors configured in the Aspire
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a singleseedconnectorGet information about a single seed connector configured in Aspire
Query String and Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Addseedconnector(s)Add one or more seeds connectors to Aspire
Request Body Parameters
Examples Add a single seedconnector
Add multiple seedsconnectors
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Updateseedconnector(s)Update one or more seeds connectors 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 seedconnector
Update multiple seedsconnectors
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deleteseedconnector(s)Delete one or more seeds connectors from Aspire.
Query String, Path and Request Body Parameters
Examples Delete a single seedconnector
Delete multiple seedsconnectors
Delete multiple seeds connectors (alternative form)
Response
Status
| |||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||
Crawl controlStart, stop, pause and resume crawls of one or more seeds.
Query String, Path and Request Body Objects | |||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier(s) of the seed(s) to control | ||||||||||||||||||||||||||||||||||||||||
action | string | Optional | The action to perform:
Defaults to start if not specified | ||||||||||||||||||||||||||||||||||||||||
type | string | Optional | The type of crawl to start:
Defaults to incremental if not specified |
Code Block | ||
---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Starts a crawl for multiple seeds
Code Block | ||
---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Starts a crawl for seeds (alternative form)
Code Block | ||
---|---|---|
| ||
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Response code | Description |
---|---|
200 | Success |
404 | Not found - a given seed connector identifier was not found |
406 | Not acceptable - there was an issue validating the input |