Get a sysctl entry

GET 
/node/:hostname/sysctl/:key

Get a specific managed sysctl entry by key 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).

key stringrequired

Possible values: non-empty, Value must match regular expression ^[a-z0-9._-]+$

Sysctl parameter key (e.g., net.ipv4.ip_forward).

Responses

200

Sysctl entry detail.

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.

key string

Sysctl parameter key.

value string

Current value of the sysctl parameter.

error string

Error message if the agent failed to retrieve this entry.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "status": "ok",
      "key": "string",
      "value": "string",
      "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

Sysctl entry 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 retrieving sysctl entry.

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