Warning

title	Page in development

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

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

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Section

Get all

seeds

connections

Lists all the seeds connections configured in the Aspire. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

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

connections

Pagination query string parameters

Sorting query string parameter

Section

Get all connections, filtered

Lists connections configured in the Aspire, filtered by a specified criteria. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The connection filter definition here

seedstringOptionalFilter returned seeds to only those whose seed matches the given expression

Response

Code Block

language	js
theme	RDark

{
    "seedcount": [{
    {
      "idtotalItems": "191283d9-183e-4820-8932-32b1fa07d2d5",2
    },
    "connectorconnection": "accd3396-6004-47c9-80a6-d6ae283878f5",
[
       "seed": "c:\\testdata\\2500",
  {
     "priority": "medium",
      "checksumid": "499207DDF2E673B3B33D74566D7457B5f0e88016-1a27-42b6-a5ae-31ab2226dbdc",
       "crawl": {
        "managertype": "manager_192.168.188.55:50505//AAABc8Mnl84=ldap",
            "modedescription": "fullLDAp-ik",
            "phaseproperties": "crawlStart",
{
          "state      "useScript": "runningfalse",
        "start": 1596707252548
      }
 "useSearchBase": "true",
      },
    {
      "idserver": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3ldap://localhost:20389",
                "connectorauthentication": "accd3396-6004-47c9-80a6-d6ae283878f5simple",
       "seed": "c:\\testdata\\2500",
         "priorityuser": "mediumcn=admin,dc=accenture,dc=com",
         "checksum       "password": "5647E40827A6C09CBA868294BB437CE5Adm1n!",
       "crawl": {
        "phasesearchBase": "idledc=accenture,dc=com",
        "state        "userQuery": "never(objectClass=person)",
        }
    }
  ],
  "messagegroupQuery": "optional response message"
}

Status

Response codeDescription200Success Section

Get a single seed

Get information about a single seed configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/seeds/:id

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe id of the seed to return

Response

Code Block

language	js

{
  "seed": {
(objectClass=groupOfUniqueNames)",
                "userAttributes": "<users><attribute>uid</attribute><attribute>givenName</attribute></users>",
                "iduserKeyAttr": "191283d9-183e-4820-8932-32b1fa07d2d5dn",
         "connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
       "seeduserNameAttr": "c:\\testdata\\2500uid",
                "prioritygroupKeyAttr": "mediumdn",
                "checksumgroupNameAttr": "499207DDF2E673B3B33D74566D7457B5ou",
     "crawl": {
        "manager   "groupMappingAttr": "manager_192.168.188.55:50505//AAABc8Mnl84=uniqueMember",
                "modegroupsHoldMembers": "fulltrue",
         "phase": "crawlStart",
      "stateuserGUID": "runningtrue",
      "start": 1596707252548
    }
  },
   "messageuserGUIDName": "optional response message"
}

Status

Response codeDescription200Success404The given seed id was not found Section

Add seeds

Add one or more seeds to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds

Request Body Parameters

"objectGUID",
                "isBinaryGUID": "true",
                "lowerCase": "false"
            }
        },
        {
            "id": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
            "type": "filesystem",
            "description": "Fs-ik",
            "properties": {
                "multipleStartPoints": "false",
                "url": "C:\\tmp\\ach1",
                "partialScan": "false",
                "subDirUrl": null,
                "indexContainers": "false",
                "scanRecursively": "true",
                "scanExcludedItems": "false",
                "ignoreScanErrors": "false",
                "ignoreSymLinks": "false",
                "useACLs": "false",
                "acls": null,
                "includes": ".*test1.*",
                "excludes": null
            }
        }
    ]
}

Status: 200

Section

Get a single connection

Get information about a single connection configured in Aspire. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the connection to return

Response

Code Block

language	js
theme	RDark

{
  "connection": {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
}

Status: 200, 404

Examples

Add a single seed

Section

Add connection(s)

Add connections to Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections

Body Parameters

Name	Type	Required	Description
type	string	Required	The type of server to add
description	string	Required	An optional description of the server
credential	string	Optional	Credential id can be specified for the server
deleteIncrementalPolicy	string	Optional	Delete policy id
throttlePolicy	string	Optional	Throttle policy id
routingPolicies	string array	Optional	Routing policies ids
properties	JSON	Required	Dynamic JSON object with server properties

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/connections
[{
   "type": "filesystem",
   "description": "Local storage",
   "deleteIncrementalPolicy": "deletePolicyId",
   "throttlePolicy": "throttlePolicyId",
   "routingPolicies": ["routingPolicyId1", "routingPolicyId2"],
   "properties": { This will be a dynamic JSON object }
 },
 {

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

language	js

POST /aspire/_api/seeds
{
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
}

Add multiple seeds

Code Block

language	js

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

language	js

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

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the input Section

Update seeds

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/seeds/:id

PUT /aspire/_api/seeds

Request Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the seed to updateseedstringRequiredThe url/path indicating the content to crawltypestringRequiredThe type of connector to use for this seed (may be omitted if connector is specified)connectorstringRequiredThe identifier of the connector configuration to use for this seed (may be omitted if type is specified)descriptionstringOptionalAn optional description of the seedcredentialstringOptionalAn optional id of the credential to use for this seedpolicystringOptionalAn optional list of the policy identifiers to use for this seedworkflowstringOptionalAn optional list of the workflow identifiers to use for this seed

Examples

Update a single seed

Code Block

language	js

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

Update multiple seeds

Code Block

language	js

PUT /aspire/_api/seeds
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
  },
  "AAABcIueWUc=description": {
    "id": "AAABcIueWUc="Remote Storage",
    "seedcredential": "c:\\testdata\\250000cred_1",
    "connectorproperties": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
{ This will be a dynamic JSON object }
}]

Response

Code Block

language	js
theme	RDark

{
  "connection": [
    {
      "policyid": "policy_15d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "workflowtype":  [ "workflow_1filesystem","workflow_99"]
  }
}

Response

Code Block

language	js

{
  "seed": [{
        
      "iddescription": "AAABcID5GBc=Local Storage",
      "seedproperties": "c:\\testdata\\2500",
    "type": "filesystem",
    "status": "N"
{ This is a dynamic JSON object}
    },
    {
      "id": "AAABcIueWUc=5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "filesystemsmb",
      "seeddescription": "c:\\testdata\\250000Remote Storage",
  	  "connectorcredential": "connectorcred_1",
      "descriptionproperties": "250,000 files",
    "credential": "cred_1",{ This is a dynamic JSON object}
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
    "status": "N"
  }],
  "message": "optional response message"
}

Status

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

}
  ]
}

See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors.

Status: 201, 406

Crawl control

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

Section

Update connection(s)

Update connections in Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed

Section

Delete seeds

Delete one or more seeds from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE PUT /aspire/_api/seedsconnections/:id

DELETE PUT /aspire/_api/seedsconnections

Path and Query String Parameters

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

Examples

Delete a single seed

Code Block

language	js

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

Delete multiple seeds

Code Block

language	js

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

connection to update

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connection to update
(see add connection)		x

x - at least one field must be present

ExampleResponse

Code Block

language	js
theme	RDark

PUT /aspire/_api/connections
{
  "messageAAABcID5GBc=": {
    "id"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

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

: "AAABcID5GBc=",
    "description": "Local Storage",
    "properties": { This is a dynamic JSON object}
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "description": "Remote Storage",
    "credential": "cred_2"
  }
}

Response

Code Block

language	js
theme	RDark

{"server":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}

Status: 200, 404, 406

Section

Update connections, filtered

Update connections configured in the Aspire, filtered by a specified criteria. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connections/updateAll

Filters: The connection filter definition here

Update body parameter

Code Block

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION"
	"credential" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"properties" : {},
    "deleteIncrementalPolicy": "deletePolicyId",
	"routingPolicies" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.add" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.remove" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
  }
}

Response

Code Block

language	js
theme	RDark

{
  "message": "update result response message"
}

Status: 200, 406

Examples

Starts an incremental crawl for a single seed

Section

Delete connection(s)

Delete one or more connections from Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.

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

DELETE /aspire/_api/connections/:id

DELETE /aspire/_api/connections

POST /aspire/_api/seeds/control/rebalance

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404The given batch id was not found

connections/delete

Path Parameters and Query parameters

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

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the connection(s) to delete

Examples

Code Block

language	js
theme	RDark

DELETE /aspire/_api/connections/AAABcID5GBc

DELETE /aspire/_api/connections?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/connections/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js
theme	RDark

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Section

Delete multiple connections, filtered

Delete multiple connections from Aspire, filtered by a specified criteria. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/deleteAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "message": "optional response message"
}

Status: 200

Section

Export connection(s)

Export one or more connections from Aspire. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections/export

GET /aspire/_api/connections/export/:id

POST /aspire/_api/connections/exportAll

Info

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Note
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Note
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

Path Parameters and Query parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the connection(s) to export

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the connection(s) to export

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/connections/export/AAABcID5GBc

DELETE /aspire/_api/connections/export?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/connections/export
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RESTConnection",
          "credential": "<credential_id>",
          "properties": {
            ...
          }
        },
		...
      ]
    },
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "RESTCredentials",
          "properties": {
            "type": "bearer",
            "query": {
              ...
            }
          }
        },
		...
      ]
    }
  }
}

Status: 200, 404, 406

Section

Export multiple connections, filtered

Export multiple connections from Aspire, filtered by a specified criteria. This endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RESTConnection",
          "credential": "<credential_id>",
          "properties": {
            ...
          }
        },
		...
      ]
    },
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "RESTCredentials",
          "properties": {
            "type": "bearer",
            "query": {
              ...
            }
          }
        },
		...
      ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Seed filter:

Code Block

language	js
theme	RDark

{ 
  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
    "deleteIncrementalPolicy": "deletePolicyId",
	"credentials" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"routingPolicies" : ["RP1", "RP2", "RP3", ...]
  }
}

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Get all

connections

Get all connections, filtered

Get a single seed

Add seeds

Get a single connection

Add connection(s)

Update seeds

Crawl control

Update connection(s)

Delete seeds

Update connections, filtered

Delete connection(s)

Re-balance seed allocation

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

Get all

connections

Get all connections, filtered

Get a single seed

Add seeds

Get a single connection

Add connection(s)

Update seeds

Update connection(s)

Delete seeds

Crawl control

Update connections, filtered

Delete connection(s)

Re-balance seed allocation

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor