Retrieve node status

GET 
/node/status

Get the current status of the node including hostname, uptime, load averages, memory, and disk usage.

Request

Query Parameters

target_hostname string

Default value: _any

Target: _any (load-balanced), _all (broadcast), hostname (direct), or key:value (label group, e.g., group:web.dev).

Responses

200

A JSON object containing the node's status information.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

The hostname of the system.

uptime string

The uptime of the system.

load_average

object

The system load averages for 1, 5, and 15 minutes.

1min numberrequired

Load average for the last 1 minute.

5min numberrequired

Load average for the last 5 minutes.

15min numberrequired

Load average for the last 15 minutes.

memory

object

Memory usage information.

total integerrequired

Total memory in bytes.

free integerrequired

Free memory in bytes.

used integerrequired

Used memory in bytes.

disks

object[]

List of local disk usage information.

Array [

name stringrequired

Disk identifier, e.g., "/dev/sda1".

total integerrequired

Total disk space in bytes.

used integerrequired

Used disk space in bytes.

free integerrequired

Free disk space in bytes.

]

os_info

object

Operating system information.

distribution stringrequired

The name of the Linux distribution.

version stringrequired

The version of the Linux distribution.

error string

Error message if the agent failed to process the request.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "my-linux-server",
      "uptime": "0 days, 4 hours, 1 minute",
      "load_average": {
        "1min": 0.32,
        "5min": 0.28,
        "15min": 0.25
      },
      "memory": {
        "total": 8388608,
        "free": 2097152,
        "used": 4194304
      },
      "disks": [
        {
          "name": "/dev/sda1",
          "total": 500000000000,
          "used": 250000000000,
          "free": 250000000000
        }
      ],
      "os_info": {
        "distribution": "Ubuntu",
        "version": "20.04"
      },
      "error": "string"
    }
  ]
}

400

Invalid request parameters.

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 retrieving node status.

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...