List all services

GET 
/node/:hostname/service

List all systemd services on the target node.

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

Target agent hostname, reserved routing value (_any, _all), or label selector (key:value).

Responses

200

List of services.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

Hostname of the agent that reported this entry.

status stringrequired

Possible values: [ok, failed, skipped]

The status of the operation for this host.

services

object[]

List of services on this host.

Array [

name string

Service unit name.

status string

Active status of the service.

enabled boolean

Whether the service is enabled to start on boot.

description string

Service description from the unit file.

pid integer

Main process ID of the service.

]

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "status": "ok",
      "services": [
        {
          "name": "nginx",
          "status": "active",
          "enabled": true,
          "description": "A high performance web server",
          "pid": 1234
        }
      ],
      "error": "string"
    }
  ]
}

400

Bad request - validation error.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error listing services.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...