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
Table of Contents |
---|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all seedsLists all the seeds configured in the Aspire
Query String Parameters
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 | tag | string | Optional | Filter returned seeds to only those whose tags matches the given expression | connector | string | Optional | Filter returned seeds to only those whose connector description matches the given expression |
Filter returned seeds to only those with the given status(es) |
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Geta single seedall seeds, filteredLists seeds configured in the Aspire, filtered by a specified criteriaGet information about a single seed configured in Aspire
Path Query String Parameters
Response
Body Parameters
Response
Status | ||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||||||||||||||||
404 | The given seed id was not found |
"created": 1596707252548,
"updated": 1596707252548
},
"workflow": {
"id": "accd3396-4820-8932-80a6-f57191283d98",
"description": "My workflow",
"type": "connector",
"created": 1596707252548,
"updated": 1596707252548
},
"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",
"connector": {
"id": "accd3396-6004-47c9-80a6-d6ae283878f5",
"description": "NetApp Connector",
"type": {
"id": "filesystem",
"name": "File System"
},
"created": 1596707252548,
"updated": 1596707252548
},
"workflow": {
"id": "accd3396-4820-8932-80a6-f57191283d98",
"description": "Stager Workflow",
"type": "connector",
"created": 1596707252548,
"updated": 1596707252548
},
"priority": "medium",
"checksum": "5647E40827A6C09CBA868294BB437CE5",
"crawl": {
"phase": "idle",
"state": "never"
},
"properties": { This will be a dynamic JSON object }
}
]
} |
Status
Response code | Description |
---|---|
200 | Success |
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single seedGet information about a single seed configured in Aspire
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seedsAdd | ||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||
Add seedsAdd one or more seeds to Aspire
Request Body Parameters
Examples Add a single seed Code Block | | |||||||||||||||||||||||||||||||||||||||
|
seed |
ExampleAdd 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", "policy": "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\\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 }] } |
Status
Response code | Description |
---|---|
201 | Created |
406 | Not acceptable - there was an issue validating the input |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update seedsUpdate one or more seeds in Aspire.
Request Body Parameters
Examples Update a single seedExample
Update multiple seeds
Response
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple seeds, filteredDelete multiple seeds from Aspire, filtered by a specified criteria
Body Parameters
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deleteseedssingle seedDelete one or more seeds from Aspire.
Path and Query String Parameters
ExamplesExample Delete a single seed
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Crawl controlStart, stop, pause and resume crawls of one or more seeds.
Path, Query String and Request Body Objects
Examples Starts an incremental crawl for a single seed
Starts an full crawl for a single seed
Pauses a crawl for a single seed
Starts a crawl for multiple seeds
Starts a crawl for multiple seeds (alternative)
Response
Starts a crawl for multiple seeds (alternative)
Status
|
Section | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Re-balance seed allocationAllows an administrator to manually re-balance the seed to manager allocation for active crawls
Status
| |||||||||||||||||||||||||
Section | |||||||||||||||||||||||||
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get seed type dxfReturns the dxf for a specific seed type Re-balance seed allocationAllows an administrator to manually re-balance the seed to manager allocation for active crawls
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials filter:
Get seed type dxfReturns the dxf for a specific seed type
Query String Parameters | ||||||||||||||||||||
Name | Type | Required | Description |
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status