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
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single serviceGet information about a single service configured in Aspire
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add servicesAdd one or more services to Aspire
Request Body Parameters
Examples Add a single service
Add multiple services
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update servicesUpdate one or more 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
Request Body Parameters
Examples Update a single service
Update multiple services
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete servicesDelete one or more services from Aspire.
Path and Query String Body Parameters
Examples Delete a single service
Delete multiple services
Response
Status
|
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
|