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
Pagination query string parameters
Expand query string parameters: connector, workflows, server, policies
Lists seeds configured in the Aspire, filtered by a specified criteria
POST /aspire/_api/seeds/getAll
Pagination query string parameters
Expand query string parameters: connector, workflows, server, policies
Response
{ "seed": [ { "id": "191283d9-183e-4820-8932-32b1fa07d2d5", "description": "2500 test", "type": "filesystem", "seed": "\\Directory1", "server": "serverId1", "connector": { "id": "accd3396-6004-47c9-80a6-d6ae283878f5", "description": "NetApp Connector", "type": "File System" }, "workflow": { "id": "accd3396-4820-8932-80a6-f57191283d98", "description": "My workflow", "type": "connector" }, "priority": "medium", "tags": [ "UK", "GE", "FR" ], "checksum": "499207DDF2E673B3B33D74566D7457B5", "crawl": { "manager": "manager_192.168.188.55:50505//AAABc8Mnl84=", "mode": "full", "phase": "crawlStart", "state": "running", "start": 1596707252548, "next": 1596707252548 }, "properties": { This will be a dynamic JSON object } }, { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "seed": "c:\\testdata\\2500", "server": "serverId1", "connector": { "id": "accd3396-6004-47c9-80a6-d6ae283878f5", "description": "NetApp Connector", "type": "filesystem", }, "workflow": { "id": "accd3396-4820-8932-80a6-f57191283d98", "description": "Stager Workflow", "type": "connector", }, "priority": "medium", "checksum": "5647E40827A6C09CBA868294BB437CE5", "crawl": { "phase": "idle", "state": "never" }, "properties": { This will be a dynamic JSON object } } ] }
Status: 200
Get information about a single seed configured in Aspire
GET /aspire/_api/seeds/:id
Expand query string parameters: connector, workflows, server, policies
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the seed to return |
Response
{ "seed": { "id": "191283d9-183e-4820-8932-32b1fa07d2d5", "connector": "accd3396-6004-47c9-80a6-d6ae283878f5", "seed": "c:\\testdata\\2500", "priority": "medium", "checksum": "499207DDF2E673B3B33D74566D7457B5", "crawl": { "manager": "manager_192.168.188.55:50505//AAABc8Mnl84=", "mode": "full", "phase": "crawlStart", "state": "running", "start": 1596707252548 }, "properties": { This will be a dynamic JSON object } } }
Status: 200, 404
Add seeds to Aspire
POST /aspire/_api/seeds
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) - see Connectors API |
description | string | Required | An description of the seed |
server | string | Required | a server id - see Servers API |
credential | string | Optional | An optional id of the credential to use for this seed - see Credentials API |
policies | string | Optional | An optional list of the policy identifiers to use for this seed - see Policies API |
workflows | string | Optional | An optional list of the workflow identifiers to use for this seed - see Workflow API |
tags | string | Optional | An optional list of the tags to use for this seed |
Example
POST /aspire/_api/seeds [{ "seed":"\\Directory1", "connector":"connectorId", "server":"serverId", "type":"filesystem", .... }, { "seed":"\\Directory2", "connector":"connectorId", "server":"serverId", "type":"filesystem", .... "policies": ["policy_1"], "workflows": ["workflow_1","workflow_99"] }]
Response
{ "seed": [{ "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "connector": "accd3396-6004-47c9-80a6-d6ae283878f5", "seed": "c:\\testdata\\2500", "priority": "medium", "checksum": "5647E40827A6C09CBA868294BB437CE5", "crawl": { "phase": "idle", "state": "never" } }, { "id": "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" } }, "properties": { 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
Update seeds in Aspire.
PUT /aspire/_api/seeds/:id
PUT /aspire/_api/seeds
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the seed to update |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the seed to update |
... |
+ fields from "Add" section...
Example for more 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", "policies": ["policy_1"], "workflows": ["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", "policies": ["policy_1"], "workflows": ["workflow_1","workflow_99"] "status": "N" }, "properties": { 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: 200, 404, 406
Update connectors configured in the Aspire, filtered by a specified criteria
POST /aspire/_api/seeds/updateAll
Filters: The seed filter definition here
{ "update" : { "description" : "DESCRIPTION" "connector" : "connectorId", "server" : "server", "tags" : ["TAG1", "TAG2", "TAG3", ...], "tagsAdd" : ["TAG1", "TAG2", "TAG3", ...], "tagsRemove" : ["TAG1", "TAG2", "TAG3", ...], "workflows" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...] "workflowsAdd" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...] "workflowsRemove" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...] } }
{ "message": "update result response message" }
Status: 200, 406
Delete one or more seeds from Aspire.
DELETE /aspire/_api/seeds/:id
DELETE /aspire/_api/seeds
POST /aspire/_api/seeds/delete
Path Parameters and query parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed(s) to delete |
Body parameters
Name | Type | Required | Description |
---|---|---|---|
ids | string | Required | The identifier(s) of the connector(s) to delete |
Example
DELETE /aspire/_api/seeds/AAABcID5GBc DELETE /aspire/_api/seeds?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/seeds/delete { "ids":["AAABcID5GBc","AAABcID5GBd"] }
Response
{ "message": "delete result response message" }
Status: 200, 404, 406
Start, stop, pause and resume crawls of one or more seeds.
POST /aspire/_api/seeds/:id/control
POST /aspire/_api/seeds/control
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 |
Examples
Starts an incremental crawl for a single seed
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control
Starts an full crawl for a single seed
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full
Pauses a crawl for a single seed
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pause
Starts a crawl for multiple seeds
POST /aspire/_api/seeds/control [{ "id": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=" }]
Starts a crawl for multiple seeds (alternative)
PUT /aspire/_api/seeds/control { "id": ["AAABcID5GBc=", "AAABcIueWUc="] }
Response
{ "message": "optional response message" }
Status: 200, 404, 406
Allows an administrator to manually re-balance the seed to manager allocation for active crawls
POST /aspire/_api/seeds/control/rebalance
Response
{ "message": "optional response message" }
Status: 200, 404
Returns the dxf for a specific seed type
GET /aspire/_api/seeds/type/:typeId/dxf
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
typeId | string | Required | Id of the type of the seed |
Response
{ "dxf": {...} "message": "optional response message" }
Status: 200, 404
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Seed filter:
"filter" : { "ids" : ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "state" : "state", "server" : "server", "tags" : ["TAG1", "TAG2", "TAG3", ...], "workflows" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...] }