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

Section

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

Response

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 code	Description
200	Success

Section

Get a single connector

Get information about a single connector configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/connector?id=:id

GET /aspire_api/connector/:id

Query String and Path Parameters

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

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 id was not found

Section

Add connector(s)

Add one or more connectors to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/connector

Request Body Parameters

Name	Type	Required	Description
type	string	Required	The type of connector to use for this connector (may be omitted if connector is specified)
description	string	Optional	An optional description of the connector

Examples

Add a single connector

Code Block

language	js

{
  "type": "filesystem",
  "description": "NetApp"
  ...
}

Add multiple connectors

Code Block

language	js

[{
  "type": "filesystem",
  "description": "NetApp"
  ...
},
{
  "type": "sharepoint",
  "description": "SharePoint Online"
  ...
}]

Response

Code Block

language	js

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

Status

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

Section

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 /aspire_api/connector

Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connector to update
type	string	Required	The type of connector to use for this connector (may be omitted if connector is specified)
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"
}

Response

Code Block

language	js

{
  "connector": {
    "id": "AAABcID5GBc=",
    "Descriptiondescription": "Net App",
    "type": "filesystem",
    "status": "N"
   },
  "message": "optional response message"
}

Status

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

Section

Delete connector(s)

Delete one or more connectors from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/connector?id=:id

DELETE /aspire_api/connector/:id

DELETE /aspire_api/connector

Query String, Path and Request Body Parameters

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

Examples

Delete a single connector

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete multiple connectors

Code Block

language	js

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

Delete multiple connectors (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 was not found
406	Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 6

New Version 7

Key

List connectors

Get a single connector

Add connector(s)

Update connector

Delete connector(s)

Page tree

Page History

Versions Compared

Old Version 6

New Version 7

Key

List connectors

Get a single connector

Add connector(s)

Update connector

Delete connector(s)