Retrieve node hostname

GET 
/node/:hostname/hostname

Get the current hostname and labels of the 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

A JSON object containing the node's hostname.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

The system's hostname.

status stringrequired

Possible values: [ok, failed, skipped]

The status of the operation for this host.

labels

object

Key-value labels configured on the agent.

property name* string

changed boolean

Whether the operation modified system state.

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "my-linux-server",
      "status": "ok",
      "labels": {},
      "changed": true,
      "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 hostname.

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