Warning | ||
---|---|---|
| ||
Aspire 5.0 does not currently support services |
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
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||
---|---|---|---|---|---|---|---|
Get all servicesLists all the services configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Query String Parameters | |||||||
Name | Type | Required | Description | description | string | Optional | Filter returned services to only those whose description matches the given expression
Section | |||||||
---|---|---|---|---|---|---|---|
Get all services, filteredLists services configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters |
Response
Code Block | ||
---|---|---|
| ||
{ "service": [ { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": { "id": "ldap-cache", "name": "LDAP cache" }, "description": "America LDAP", "created": 1596707252548, "properties": { This is a dynamic JSON object } }, { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": { "id": "group-expansion", "name": "Group expansion service" }, "description": "Group Expansion", "created": 1596707252548, "properties": { This is a dynamic JSON object } } ], "from": 100, "size": 10, "totalItems": 10000, "message": "optional response message" } |
: 200
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single serviceGet information about a single service configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | 404 | The given service id was not found
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Addservicesservice(s)Add one or more services to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Request Body Parameters
Examples Add a single service
Add multiple services
Response
| ||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||
201 | Created | 406 | Not acceptable - there was an issue validating the input
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Updateservicesservice(s)Update 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, this endpoint need the at least the ADMINISTRATOR role to be executed.
Request Body ParametersPath Parameter
Request Body Parameters
x - at least one field must be present 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, this endpoint need the at least the ADMINISTRATOR role to be executed.
Response
| ||||||||||||
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 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple services, filteredDelete multiple services from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Response
Status: 200 |
Section | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete service(s) | ||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||
Delete services Delete one or more services from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters and Query String Body Parametersparameters
Examples Delete a single service Body Parameter
Examples
Delete multiple services
Response
| ||||||||||||||||||||||||||||||||||||||
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
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Control servicesControl one or more services from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
QueryString, Path and Request Body Parameters
Examples Start a single service
Start multiple services
Start multiple services (alternative form)
Response
| |||||||||||||||||||||||||||||||||||||||
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