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
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||
---|---|---|---|---|---|---|---|
Get all seedsLists all the seeds configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
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 |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all seeds, filteredLists seeds configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters Sorting query string parameters Expand query string parameters: connector, workflows, connection, policies |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "seedcount": [{ { "idtotalItems": "191283d9-183e-4820-8932-32b1fa07d2d5",1 "description": "2500 test"}, "seed": "c:\\testdata\\2500",[ "connector": { "id": "accd3396b4adeb8c-60043deb-47c94379-80a6ad52-d6ae283878f5e2a8d219a84a", "descriptiontype": "NetApp Connectorfilesystem", "typedescription": {"pepoSeed", "idconnector": "filesystem16e901a5-75c7-4969-90d2-70ad299916f3", "nameseed": "File SystemDirectory1", }, "createdpriority": 1596707252548"medium", "updatedchecksum": 1596707252548 "11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40", }, "workflowcrawl": { "id": "accd3396-4820-8932-80a6-f57191283d98", "descriptionmanager": "My workflowmanager_192.168.0.16:40505//AAABeOQLewo=", "type "mode": "connectorfull", "created": 1596707252548, "phase": "updated": 1596707252548 idle", }, "prioritystate": "mediumcompleted", "tags": [ "UKstart": 1618736207176, "GE", "FRend": 1618736273635 ], "checksum": "499207DDF2E673B3B33D74566D7457B5"}, "crawl": { "manager"connection": "manager_192.168.188.55:50505//AAABc8Mnl84=98960f72-aab0-4ba1-a90e-b29d4e3c2c92", "mode": "full", "phaseworkflows": "crawlStart",72022651-c2f4-45a9-9e18-2b0ace529cda" "state": "running",} "start": 1596707252548, "next": 1596707252548 } }, { ] } |
Status: 200
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single seedGet information about a single seed configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Expand query string parameters: connector, workflows, connection, policies Path Parameters
Response
| ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | |||||||||||||||||||||
Section | ||||||||||||||||||||||
: 200, 404 |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seed(s)Add seeds to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. Get a single seedGet information about a single seed configured in Aspire
Path Body Parameters
Response
Example
Status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | The given seed id was not found | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response
Add seedsAdd one or more seeds to Aspire
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 |
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds
{
"seed": "c:\\testdata\\2500",
"type": "filesystem"
} |
Add multiple seeds
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds [{ "seed": "c:\\testdata\\2500", "type": "filesystem" }, { "seed": "c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policythrottlePolicy": "policy_1", "workflow": ["workflow_1","workflow_99"] }] |
Response
Code Block | ||
---|---|---|
| ||
{ "seed": [{ "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "connector": "accd3396-6004-47c9-80a6-d6ae283878f5", "seed": "c:\\testdata\\250025000", "priority": "medium", "checksum": "5647E40827A6C09CBA868294BB437CE5", "crawl": { "phase": "idle", "state": "never" } }, { "id"properties": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"] "seed": "c:\\testdata\\25000", "priority": "medium", "checksum": "5647E40827A6C09CBA868294BB437CE5", "crawl": { "phase": "idle", "state": "never" } }] } |
Status
{ This will be a dynamic JSON object }]
} |
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 201, 406
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update seed(s)Update seeds in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
x - at least one field must be present Example for more seeds
Update seedsUpdate one or more seeds in Aspire.
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 |
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds/AAABcID5GBc%3D
{
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem"
} |
Update multiple seeds
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds { "AAABcID5GBc=": { "id": "AAABcID5GBcAAABcIueWUc=", "seedconnector": "c:\\testdata\\2500connector_1", "typedescription": "filesystem250,000 files", }, "AAABcIueWUc=routingPolicies": {["policy_1"], "idworkflows": ["AAABcIueWUc=workflow_1","workflow_99"] } } |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{"seed": [{"updated"c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"] } } |
Response
Code Block | ||
---|---|---|
| ||
{
"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"
}]
} |
Status
Delete one or more seeds from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Query String Parameters
:true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]} |
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 seeds, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Filters: The seed filter definition here
Status: 200, 406 |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete seed(s)Delete one or more seeds from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier(s) of the seed(s) to delete |
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/seeds/AAABcID5GBc%3D |
Delete multiple seeds
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/seeds
{
"id": [ "AAABcID5GBc=", "AAABcIueWUc=" ]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Start, stop, pause and resume crawls of one or more seeds.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path , Query String and Request Body ObjectsParameters and query parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed(s) to controldeleteaction |
Body parameters
Name | Optional | The action to perform:
Defaults to start if not specified | Type | Required | Description |
---|---|---|---|---|---|
idstype | string | OptionalRequired | The type of crawl to start:
Defaults to incremental if not specified |
Examples
identifier(s) of the connector(s) to delete |
ExampleStarts an incremental crawl for a single seed
Code Block | ||||
---|---|---|---|---|
| ||||
DELETE POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control |
Starts an full crawl for a single seed
Code Block | ||
---|---|---|
| ||
POSTAAABcID5GBc DELETE /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full |
Pauses a crawl for a single seed
Code Block | ||
---|---|---|
| ||
?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pausedelete { "ids":["AAABcID5GBc","AAABcID5GBd"] } |
ResponseStarts a crawl for multiple seeds
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/control [{ "idmessage": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=delete result response message" }] |
Starts a crawl for multiple seeds (alternative)
Status: 200, 404, 406
Section | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple seeds, filteredDelete multiple seeds from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
| |||||||||||
Code Block | |||||||||||
| |||||||||||
PUT
Filters: The seed filter definition here Response
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional
|
: 200 |
Section | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Crawl controlStart, stop, pause and resume crawls of one or more seeds, this endpoint need the at least the OPERATOR role to be executed.
Re-balance seed allocationAllows an administrator to manually re-balance the seed to manager allocation for active crawls
Status | ||||||||||||||||
Response code | Description | |||||||||||||||
200 | Success | 404 | The given batch id was not found
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed(s) to control |
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
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 |
Body
Optionally, a filter can be added to specify which seeds to start
Examples
Starts an incremental crawl for a single seed
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control |
Starts an full crawl for a single seed
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full |
Reprocess only errored documents from the previous crawl
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=reprocess |
Pauses a crawl for a single seed
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pause |
Starts a crawl for multiple seeds
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/control
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Starts a crawl for multiple seeds (alternative)
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/control
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"message": "optional response message"
} |
Status: 200, 404, 406
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export seed(s)Export one or more seed from Aspire, this endpoint needs at least the OPERATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|