Get process by PID

GET 
/node/:hostname/process/:pid

Get detailed information about a specific process by PID.

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

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

pid integerrequired

Possible values: >= 1

Process identifier (PID).

Responses

200

Process detail.

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

status stringrequired

Possible values: [ok, failed, skipped]

The status of the operation for this host.

process

object

Information about a running process.

pid integer

Process identifier.

name string

Process name.

user string

User running the process.

state string

Process state.

cpu_percent double

CPU usage percentage.

mem_percent float

Memory usage percentage.

mem_rss int64

Resident set size in bytes.

command string

Full command line.

start_time string

Process start time.

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "status": "ok",
      "process": {
        "pid": 1234,
        "name": "nginx",
        "user": "www-data",
        "state": "running",
        "cpu_percent": 2.5,
        "mem_percent": 1.2,
        "mem_rss": 12345678,
        "command": "nginx: master process /usr/sbin/nginx",
        "start_time": "2026-01-15T10:30:00Z"
      },
      "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
}

404

Process not found.

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

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