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",
    "created": 1596707252548,
    "updated": 1596707252548 
  },
  {
    "id": "AAABcIueWUc=",
    "type": "shareoint-online",
    "description": "SharePoint Online",
    "created": 1596707252548,
    "updated": 1596707252548 
  }]
}

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",
    "created": 1596707252548,
    "updated": 1596707252548 
  }
}

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",
    "created": 1596707252548,
    "updated": 1596707252548 
  },
  {
    "id": "BAABcID5GBc=",
    "type": "sharepoint",
    "description": "SharePoint Online",
    "created": 1596707252548,
    "updated": 1596707252548 
  }]
}

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.

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=",
  "description": "NetApp",
  "type": "filesystem"
}

Update multiple connectors

Code Block

language	js

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "filesystem"
  },
  "AAABcID5GBc=": {
    "id": "AAABcID5GBd=",
    "description": "Sharepoint online",
    "type": "sharepoint"
  }
}

Response

Code Block

language	js

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "filesystem",
    "created": 1596707252548,
    "updated": 1596707252548 
   }]
}

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
200	Success
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"
}

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
200	Success
404	Not found - a given connector identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get connectors types

Lists all available connectors types

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/type

Query String Parameters

Name	Type	Required	Description
type	string	Optional	Filter results to return only the specified type

Response

Code Block

language	js

{
  "type": [{
    "id": "filesystem",
    "description": "Filesytem Connector"
  },
  {
    "id": "sharepoint-online",
    "description": "SharePoint Online Connector"
  },
  ...
  ]
}

Status

Response code	Description
200	Success

Section

Get specific connector type

Returns the type of a specific connector

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/:id/type

Query String Parameters

Name	Type	Required	Description

Response

Code Block

language	js

{
  "type": [{
    "id": "filesystem",
    "description": "Filesytem Connector"
  }
  ]
}

Status

Response code	Description
200	Success

Section

Get connector type dxf

Returns the dxf for a specific connector type

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/type/:typeId/dxf

Query String Parameters

Name	Type	Required	Description

Response

Code Block

language	js

{
  "dxf": {...}
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

Page tree

Versions Compared

Old Version 24

New Version 25

Key

Get all connectors

Get a single connector

Create connectors

Update connectors

Delete connectors

Get connectors types

Get specific connector type

Get connector type dxf

Page tree

Page History

Versions Compared

Old Version 24

New Version 25

Key

Get all connectors

Get a single connector

Create connectors

Update connectors

Delete connectors

Get connectors types

Get specific connector type

Get connector type dxf