Warning

title	Page in development

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

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

Table of Contents

Section

Get all connectors

Lists all the connectors configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors

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/connectors/:id

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

Create connectors

Add one or more connectors to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors

Request Body Parameters

Name	Type	Required	Description
type	string	Required	The type of this connector
description	string	Optional	An optional description of the connector

Examples

Add a single connector

Code Block

language	js

POST /aspire/_api/connectors
{
  "type": "filesystem",
  "description": "NetApp"
  ...
}

Add multiple connectors

Code Block

language	js

POST /aspire/_api/connectors
[{
  "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"
}
}

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

Status

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

Section

Update connectors

Updates one or more connectors 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/connectors/:id

PUT /aspire/_api/connectors

Path and Request Body Parameters

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

Examples

Update a single connector

Code Block

language	js

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

Update multiple connectors

Code Block

language	js

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "connector": "c:\\testdata\\2500",
    "type": "filesystem",
    ...
  },
  "AAABcID5GBc=": {
    "id": "AAABcID5GBd=",
    "connector": "c:\\testdata\\250",
    "type": "filesystem",
    ...
  }
}

Response

Code Block

language	js

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "description": "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 connectors

Delete one or more connectors from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/connectors/:id

DELETE /aspire/_api/connectors

Path and Query String 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

DELETE /aspire/_api/connectors/AAABcID5GBc=

Delete multiple connectors

Code Block

language	js

DELETE /aspire/_api/connectors?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 connector identifier was not found
406	Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 15

New Version 16

Key

Get all connectors

Get a single connector

Create connectors

Update connectors

Delete connectors

Page tree

Page History

Versions Compared

Old Version 15

New Version 16

Key

Get all connectors

Get a single connector

Create connectors

Update connectors

Delete connectors