Get Service

Get Service

Get information about a specific service.

Request
URI
GET
https://{api_host}/services/{service_id}
COPY
Path Parameters
string
service_id
Required

The ID of a service.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about a service.

Returns ServiceInfoDrResponseEntity of type(s) application/json
This response body class contains all of the following: ServiceInfo 
{
    "id": "ui-service",
    "name": "ui-service",
    "description": "string",
    "startup_type": "string",
    "is_running": false,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
Metadata
_meta
Optional

_meta


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


On This Page
Services Operations
GET
Get All Services
GET
Get Service
POST
Restart Service
POST
Start Service
POST
Stop Service