REST API - list

appliance services: list

Lists details of vCenter services. This operation was added in vSphere API 6.7.

Request:

HTTP request

GET https://{server}/rest/appliance/services
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "value"{
                "description""string",
                "state""STARTING"
            },
            "key""obj-103"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value list Map of service identifiers to service Info structures.List of {"key": string, "value": info}
value[].key string
value[].value info
value[].value.description string Service description. This attribute was added in vSphere API 6.7.

value[].value.state string Running State. This attribute was added in vSphere API 6.7.

Defines valid Run State for services. This enumeration was added in vSphere API 6.7. Value is one of:
STARTING: Service Run State is Starting, it is still not functional. This constant was added in vSphere API 6.7.
STOPPING: Service Run State is Stopping, it is not functional. This constant was added in vSphere API 6.7.
STARTED: Service Run State is Started, it is fully functional. This constant was added in vSphere API 6.7.
STOPPED: Service Run State is Stopped. This constant was added in vSphere API 6.7.

Errors:

HTTP Status Code Type Description
500 error if any error occurs during the execution of the operation.