Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The services API provides functionality that allows a administrator to perform actions such as adding and configuring services
Table of Contents |
---|
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all servicesLists all the services configured in the Aspire
Pagination query string parameters
Response
Status: 200 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single serviceGet information about a single service configured in Aspire
Path Parameters
Response
Status: 200, 404 |
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add service(s)Add one or more services to Aspire
Request Body Parameters
Examples Add a single service
Add multiple services
Response
Status: 201, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update service(s)Update one or more service in Aspire.
Path Parameter
Request Body Parameters
+ fields from "Add" section... Examples Update a single service
Update multiple services
Response
Status: 200, 404, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Update services, filteredUpdate services configured in the Aspire, filtered by a specified criteria
Response
Status: 200, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple services, filteredDelete multiple services from Aspire, filtered by a specified criteria
Response
Status: 200 |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete service(s)Delete one or more services from Aspire.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Control servicesControl one or more services from Aspire.
QueryString, Path and Request Body Parameters
Examples Start a single service
Start multiple services
Start multiple services (alternative form)
Response
Status: 200, 404, 406 |