Warning

title	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

Table of Contents

Response

Section

Release worker

Reset the status of any in memory batches that were sent to a failed worker but had not been acknowledged so the may be sent to another worker

List connectors

Lists all the connectors configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/

connector

Query String Parameters

Name Type Required Description

type string Optional Filter returned connectors to only those with the given type

description string Optional Filter returned connectors to only those whose description matches the given expression

Code Block

language	js

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp connector",
    ...
  },
  {
    "id": "AAABcIueWUc=",
    "type": "shareoint-online",
    "description": "SharePoint Online",
    ...
  }],
  "message": "optional response message"
}

Status

Response codeDescription200Success Section

manager/release/worker/:id

PUT /aspire_api/manager/release/worker/:id

PUT /aspire_api/manager/release/worker

Path and Request Body

Get a single connector

Get information about a single connector configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/connector/:id

Path Parameters

id of the connector to return

Name	Type	Required	Description
id	string	Required	The	identifier(s) of the failed worker node(s) whose batches must be reset

Response

Code Block

language	js

{
  "connector": {
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp connector",
    ...
  },
  "message": "optional response message"
}

Status

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

Section

Release seed

Used by the master manager when pausing or stopping to release all of the items for a seed from unsent batches. The manager will then forward the same to the workers

Add connector(s)

Add one or more connectors to Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/manager/release/seed/:id

PUT /aspire_api/manager/release/seed/:id

PUT

POST

/aspire_api/

connector

manager/release/seed

Path and Request Body Parameters

type type of this connector

Name	Type	Required	Description
id	string	Required	The	description	string	Optional	An optional description of the connectoridentifier(s) of the seed to be released

Examples

Add Release a single connector seed

Code Block

language	js

{
  "typeid": "filesystemAAABcID5GBc=",
  "description": "NetApp"
  ...
}

Add Release multiple connectors seeds

Code Block

language	js

[{
  "typeid": "filesystem",
  "description": "NetApp"
  ...
AAABcID5GBc="
},
{
  "typeid": "sharepointAAABcIueWUc=",
  "description": "SharePoint Online"
  ...
}]

ResponseRelease multiple seeds (alternative form)

Code Block

language	js

{
  "connectorid": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp"
    ...
  },
  {
    "type": "sharepoint",
    "description": "SharePoint Online"
    ...
  }],
  "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
201200	CreatedSuccess
404	The given seed id was not found	406	Not acceptable - there was an issue validating the input

Section

Fetch a batch

Used by the worker to fetch a batch from the manager.

Update connector

Update a connector 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

GET /aspire_api/manager/

connector

batch

Path and Request Body Parameters

Name	Type	Required	Description
idtags	string	Required	The identifier of the connector to update
type	string	Required	The type of the connector
description	string	Optional	An optional description of the connector

Examples

Update a single connector

Code Block

language	js

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

Optional

The tags this machine has

Response

Code Block

language	js

{
  "connector": {
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "filesystem",
    "status": "N"
   },
  <TODO>
  "message": "optional response message"
}

Status

Response code	Description
201200	CreatedSuccess
404	Not found - a given connector identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete connector

Acknowledge batch(

s)

es)

Used by the worker node to acknowledge the worker has taken responsibility for the batch(es)Delete one or more connectors from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/manager/batch/ack/:id

PUT DELETE /aspire_api/manager/batch/connectorack/:id

DELETE PUT /aspire_api/manager/batch/connectorack

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the connector(s) to deleteseed to be released

Examples

Delete Acknowledge a single connectorbatch

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete Acknowledge multiple connectorsbatches

Code Block

language	js

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

Delete Acknowledge multiple connectors batches (alternative form)

Code Block

language	js

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

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given connector identifier The given batch id was not found	406	Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Release worker

List connectors

Get a single connector

Release seed

Add connector(s)

Fetch a batch

Update connector

Acknowledge batch(

es)

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

Release worker

List connectors

Get a single connector

Release seed

Add connector(s)

Fetch a batch

Update connector

Acknowledge batch(

es)