Page in development

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

The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectors

List connectors

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 a single seed

Get information about a single seed configured in Aspire

GET /aspire_api/seeds?id=:id

GET /aspire_api/seeds/:id

Query String and 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 seed(s)

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

{
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
}

Add multiple 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 seed(s)

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

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

{
  "id": "AAABcID5GBc=",
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
}

Update multiple seeds

[{
  "id": "AAABcID5GBc=",
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "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 seed(s)

Delete one or more seeds from Aspire.

DELETE /aspire_api/seeds?id=:id

DELETE /aspire_api/seeds/:id

DELETE /aspire_api/seeds

Query String, Path and Request Body Parameters

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

Examples

Delete a single seed

{
  "id": "AAABcID5GBc="
}

Delete multiple seeds

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Delete multiple seeds (alternative form)

{
  "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

Crawl control

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

GET /aspire_api/seeds/crawl?id=:id&action=:action&type=:type

GET /aspire_api/seeds/crawl/:id

GET /aspire_api/seeds/crawl/:id/:action

GET /aspire_api/seeds/crawl/:id/:action/:type

POST /aspire_api/seeds/crawl

POST /aspire_api/seeds/crawl/:action

POST /aspire_api/seeds/crawl/:action/:type

Query String, Path 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:

start
stop
pause
resume
abort

Defaults to start if not specified

type

string

Optional

The type of crawl to start:

incremental
full
test

Defaults to incremental if not specified

Examples

Starts a crawl for a single seed

{
  "id": "AAABcID5GBc="
}

Starts a crawl for multiple seeds

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Starts a crawl for seeds (alternative form)

{
  "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

Page tree

List connectors

Get a single seed

Add seed(s)

Update seed(s)

Delete seed(s)

Crawl control

Contact Us: [email protected]

Page tree

Connector API

List connectors

Get a single seed

Add seed(s)

Update seed(s)

Delete seed(s)

Crawl control

Contact Us: [email protected]