Page in development
This page is in development and as such, its contents may be incorrect
The seeds API provides functionality that allows a administrator to perform actions such as adding and configuring a seed to crawl, or beginning or stopping a crawl
Lists all the seeds configured in the Aspire
GET /aspire_api/seeds
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
state | string | Optional | Filter returned seeds to only those with the given status(es) |
type | string | Optional | Filter returned seeds to only those with the given type |
description | string | Optional | Filter returned seeds to only those whose description matches the given expression |
seed | string | Optional | Filter returned seeds to only those whose seed matches the given expression |
Response
{ "seed": [{ "id": "AAABcID5GBc=", "seed": "c:\\testdata\\2500", "type": "filesystem", "description": "2,500 files", "status": "S", "start": 1584550193011, "stop": 1584550267047 }, { "id": "AAABcIueWUc=", "seed": "c:\\testdata\\250000", "type": "filesystem", "description": "250,000 files", "status": "S", "stop": 1583240224684, "start": 1583239823374 }], "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
Get information about a single seed configured in Aspire
GET /aspire_api/seeds/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the seed to return |
Response
{ "seed": { "id": "AAABcID5GBc=", "seed": "c:\\testdata\\2500", "type": "filesystem", "description": "2,500 files", "status": "S", "start": 1584550193011, "stop": 1584550267047 }, "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | The given seed id was not found |
Add one or more seeds to Aspire
POST /aspire_api/seeds
Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
seed | string | Required | The url/path indicating the content to crawl |
type | string | Required | The type of connector to use for this seed (may be omitted if connector is specified) |
connector | string | Required | The identifier of the connector configuration to use for this seed (may be omitted if type is specified) |
description | string | Optional | An optional description of the seed |
credential | string | Optional | An optional id of the credential to use for this seed |
policy | string | Optional | An optional list of the policy identifiers to use for this seed |
workflow | string | Optional | An optional list of the workflow identifiers to use for this seed |
Examples
Add a single seed
POST /aspire_api/seeds { "seed": "c:\\testdata\\2500", "type": "filesystem" }
Add multiple seeds
POST /aspire_api/seeds [{ "seed": "c:\\testdata\\2500", "type": "filesystem" }, { "seed": "c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"] }]
Response
{ "seed": [{ "id": "AAABcID5GBc=", "seed": "c:\\testdata\\2500", "type": "filesystem", "status": "N" }, { "id": "AAABcIueWUc=", "type": "filesystem", "seed": "c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"] "status": "N" }], "message": "optional response message" }
Status
Response code | Description |
---|---|
201 | Created |
406 | Not acceptable - there was an issue validating the input |
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
PUT /aspire_api/seeds/:id
PUT /aspire_api/seeds
Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the seed to update |
seed | string | Required | The url/path indicating the content to crawl |
type | string | Required | The type of connector to use for this seed (may be omitted if connector is specified) |
connector | string | Required | The identifier of the connector configuration to use for this seed (may be omitted if type is specified) |
description | string | Optional | An optional description of the seed |
credential | string | Optional | An optional id of the credential to use for this seed |
policy | string | Optional | An optional list of the policy identifiers to use for this seed |
workflow | string | Optional | An optional list of the workflow identifiers to use for this seed |
Examples
Update a single seed
PUT /aspire_api/seeds/AAABcID5GBc%3D { "id": "AAABcID5GBc=", "seed": "c:\\testdata\\2500", "type": "filesystem" }
Update multiple seeds
PUT /aspire_api/seeds { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "seed": "c:\\testdata\\2500", "type": "filesystem" }, "AAABcIueWUc=": { "id": "AAABcIueWUc=", "seed": "c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"] } }
Response
{ "seed": [{ "id": "AAABcID5GBc=", "seed": "c:\\testdata\\2500", "type": "filesystem", "status": "N" }, { "id": "AAABcIueWUc=", "type": "filesystem", "seed": "c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"] "status": "N" }], "message": "optional response message" }
Status
Response code | Description |
---|---|
201 | Created |
404 | Not found - a given seed identifier was not found |
406 | Not acceptable - there was an issue validating the input |
Delete one or more seeds from Aspire.
DELETE /aspire_api/seeds/:id
DELETE /aspire_api/seeds
Path and Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed(s) to delete |
Examples
Delete a single seed
DELETE /aspire_api/seeds/AAABcID5GBc%3D
Delete multiple seeds
DELETE /aspire_api/seeds?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D
Response
{ "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | Not found - a given seed identifier was not found |
406 | Not acceptable - there was an issue validating the input |
Start, stop, pause and resume crawls of one or more seeds.
POST /aspire_api/seeds/crawl/:id
POST /aspire_api/seeds/crawl/:id/:action
POST /aspire_api/seeds/crawl/:id/:action/:type
PUT /aspire_api/seeds/crawl
PUT /aspire_api/seeds/crawl/:action
PUT /aspire_api/seeds/crawl/:action/:type
Path, Query String 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 |
Examples
Starts an incremental crawl for a single seed
GET /aspire_api/seeds/crawl/AAABcID5GBc%3D
Starts an full crawl for a single seed
GET /aspire_api/seeds/crawl/AAABcID5GBc%3D/start/full
Pauses a crawl for a single seed
GET /aspire_api/seeds/crawl/AAABcID5GBc%3D/pause
Starts a crawl for multiple seeds
PUT /aspire_api/seeds/crawl [{ "id": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=" }]
Starts a crawl for multiple seeds (alternative)
PUT /aspire_api/seeds/crawl { "id": ["AAABcID5GBc=", "AAABcIueWUc="] }
Response
{ "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | Not found - a given seed identifier was not found |
406 | Not acceptable - there was an issue validating the input |