Page in development
This page is in development and as such, its contents may be incorrect
The service API provides functionality that allows a administrator to perform actions such as adding and configuring services
Lists all the services configured in the Aspire
GET /aspire_api/service
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Optional | Filter returned services to only those with the given type |
description | string | Optional | Filter returned services to only those whose description matches the given expression |
Response
{ "service": [{ "id": "AAABcID5GBc=", "type": "filesystem", "description": "NetApp service", ... }, { "id": "AAABcIueWUc=", "type": "shareoint-online", "description": "SharePoint Online", ... }], "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
Get information about a single service configured in Aspire
GET /aspire_api/service?id=:id
GET /aspire_api/service/:id
Query String and Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the service to return |
Response
{ "service": { "id": "AAABcID5GBc=", "type": "filesystem", "description": "NetApp service", ... }, "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | The given service id was not found |
Add one or more services to Aspire
POST /aspire_api/connector
Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of service to use for this service (may be omitted if service is specified) |
description | string | Optional | An optional description of the service |
Examples
Add a single service
{ "type": "filesystem", "description": "NetApp" ... }
Add multiple services
[{ "type": "filesystem", "description": "NetApp" ... }, { "type": "sharepoint", "description": "SharePoint Online" ... }]
Response
{ "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 |
Update a service 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
PUT /aspire_api/service
Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the service to update |
type | string | Required | The type of service to use for this service (may be omitted if service is specified) |
description | string | Optional | An optional description of the service |
Examples
Update a single service
{ "id": "AAABcID5GBc=", "service": "c:\\testdata\\2500", "type": "filesystem" }
Response
{ "service": { "id": "AAABcID5GBc=", "Description": "Net App", "type": "filesystem", "status": "N" }, "message": "optional response message" }
Status
Response code | Description |
---|---|
201 | Created |
404 | Not found - a given service identifier was not found |
406 | Not acceptable - there was an issue validating the input |
Delete one or more services from Aspire.
DELETE /aspire_api/service?id=:id
DELETE /aspire_api/service/:id
DELETE /aspire_api/service
Query String, Path and Request Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the service(s) to delete |
Examples
Delete a single service
{ "id": "AAABcID5GBc=" }
Delete multiple services
[{ "id": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=" }]
Delete multiple services (alternative form)
{ "id": ["AAABcID5GBc=", "AAABcIueWUc="] }
Response
{ "message": "optional response message" }
Status
Response code | Description |
---|---|
200 | Success |
404 | Not found - a given service identifier was not found |
406 | Not acceptable - there was an issue validating the input |