Warning | ||
---|---|---|
| ||
Aspire 5.0 does not currently support services |
Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The service services API provides functionality that allows a administrator to perform actions such as adding and configuring services
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||
---|---|---|---|---|---|---|---|
List 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
services |
Pagination query string parameters
Sorting query string parameters
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": "AAABcID5GBc=""5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": { "id": "ldap-cache", "name": "LDAP cache" }, "description": "America "Group expansion service", ... }, LDAP", "created": 1596707252548, "properties": { This is a dynamic JSON object } }, { "id": "AAABcIueWUc=", 5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "type": { "id": "group-expansion", "name": "Group expansion service" }, "description": "Group "LDAP cache service"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.
Query String and Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | |||||||||||||||||||
404 | The given service id was not found |
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add service(s)Add one or more Adds a 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 | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update service(s)Update a 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.
Path ParameterRequest Body Parameters
Request Body Parameters
x - at least one field must be present Examples Update a single service
ResponseUpdate 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)Delete one or more services from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Query String, Path Parameters and Request Body ParametersQuery parameters
Examples Delete a single service
Body Parameter
ExamplesDelete multiple services
Delete 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 | |||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||
: 200, 404, 406 |
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Control servicesControl Delete service(s)Delete one or more services from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Query StringQueryString, Path and Request Body Parameters
Examples Delete Start a single service
Start Delete multiple services
Delete 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