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 | |||||||
Name | Type | Required | Description | description | string | Optional | Filter returned services to only those whose description matches the given expression
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" } |
Status
Response code | Description |
---|---|
200 | Success |
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 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
|