Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The seeds servers API provides functionality that allows a administrator to perform actions such as adding and configuring a seed to server to crawl, or beginning or stopping a crawl

Table of Contents

Section

Get all

seeds

servers

Lists all the seeds servers configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/seedsservers

Query String Parameters

Name	Type	Required	Description
statexx	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
xx

Response

Code Block

language	js

{
  "seedserver": [
    {
      "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
      }.....
    },
    {
      "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"
  .....
    }
    }
  ],
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Section

Get a single

seed

server

Get information about a single seed server configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/seedsservers/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the seed server to return

Response

Code Block

language	js

{
  "seedserver": {
    "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
    }
  },
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given seed server id was not found

Section

Add

seeds

servers

Add one or more seeds servers to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seedsservers

Request Body Parameters

Name	Type	Required	Description
seedxx	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)
xx
xx	string	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
xx of the server

Examples

Add a single seedserver

Code Block

language	js

POST /aspire/_api/seedsservers
{
  "seedserver": "c:\\testdata\\2500",
  "type": "filesystem"
}

Add multiple seedsservers

Code Block

language	js

POST /aspire/_api/seedsservers
[{
  "seedserver": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "seedserver": "c:\\testdata\\250000",
  "connector": "connector_1",
  "description": "250,000 files",
  "credential": "cred_1",
  "policy": "policy_1",
  "workflow": ["workflow_1","workflow_99"]
}]

Response

Code Block

language	js

{
  "seedserver": [{
    "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"
    }
  }],
  "message": "optional response message"
}

Status

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Section

Update

seeds

servers

Update one or more seeds servers 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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/seedsservers/:id

PUT /aspire/_api/seedsservers

Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the seed server to updateseed
xx	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)
xx
xx	string	description	string	Optional	An optional description xx 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
server

Examples

Update a single seedserver

Code Block

language	js

PUT /aspire/_api/seedsservers/AAABcID5GBc%3D
{
  "id": "AAABcID5GBc=",
  "seedserver": "c:\\testdata\\2500",
  "type": "filesystem"
}

Update multiple seedsservers

Code Block

language	js

PUT /aspire/_api/seedsservers
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "seedserver": "c:\\testdata\\2500",
    "type": "filesystem"
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "seedserver": "c:\\testdata\\250000",
    "connector": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
  }
}

Response

Code Block

language	js

{
  "seedserver": [{
    "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 server identifier was not found
406	Not acceptable - there was an issue validating the input

Crawl control

Start, stop, pause and resume crawls of one or more seeds.

Section

Delete

seeds

servers

Delete one or more seeds servers from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/seedsservers/:id

DELETE /aspire/_api/seedsservers

Path and Query String Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the seedserver(s) to delete

Examples

Delete a single seedserver

Code Block

language	js

DELETE /aspire/_api/seedsservers/AAABcID5GBc%3D

Delete multiple seedsservers

Code Block

language	js

DELETE /aspire/_api/seedsservers?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given seed server identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds/:id/control

POST /aspire/_api/seeds/control

Path, Query String and Request Body Objects

NameTypeRequiredDescriptionidstringRequiredThe identifier(s) of the seed(s) to controlactionstringOptional

The action to perform:

start
stop
pause
resume
abort

Defaults to start if not specified

typestringOptional

The type of crawl to start:

incremental
full
test

Defaults to incremental if not specified

Examples

Starts an incremental crawl for a single seed

Code Block

language	js

POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control

Starts an full crawl for a single seed

Code Block

language	js

POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full

Pauses a crawl for a single seed

Code Block

language	js

POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pause

Starts a crawl for multiple seeds

Code Block

language	js

POST /aspire/_api/seeds/control
[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Starts a crawl for multiple seeds (alternative)

Code Block

language	js

PUT /aspire/_api/seeds/control
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given seed identifier was not found406Not acceptable - there was an issue validating the input Section

Re-balance seed allocation

Allows an administrator to manually re-balance the seed to manager allocation for active crawls

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds/control/rebalance

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given batch id was not found

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Get all

servers

Get a single

server

Add

servers

Update

servers

Crawl control

Delete

servers

Re-balance seed allocation

Page tree

Page History

Versions Compared

Old Version 1

New Version 2

Key

Get all

servers

Get a single

server

Add

servers

Update

servers

Delete

servers

Crawl control

Re-balance seed allocation