Showing VM guest OS command details

GET /v2.1/servers/{server_id}/guest-agent/commands/{command_id}

Show details of a specific guest OS command.

Request

Parameters

Name	In	Type	Description
`server_id`	path	string	The UUID of the server.
`command_id`	path	string	The UUID of the command.

Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:8774/v2.1/servers/<server_id>/guest-agent/commands/<command_id>

Response

Parameters

Name	In	Type	Description
`command`	body	object	The command object.
`uuid`	body	string	The UUID of the command.
`type`	body	string	Command type (`exec`, `file-read`, `file-write`).
`instance_uuid`	body	string	The UUID of the server.
`status`	body	string	Command execution status at the API level.
`created_at`	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In this example, the offset value is `-05:00`.
`updated_at`	body	string	The date and time when the resource was updated. If the resource has not been updated, this field will be `null`. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In this example, the offset value is `-05:00`.
`error`	body	string	Error description if the command failed. If the command succeeded, this field will be `null`.
`result`	body	object	Command execution result. The result is `null` in the following cases: The command has not yet completed (status: `PENDING`). The command failed before execution started. The command type does not return structured result data.
`pid`	body	integer	Process ID of the command executed inside the guest operating system.
`exitcode`	body	integer	Exit code returned by the executed process. A value of `0` indicates successful execution. Non-zero values indicate an error condition defined by the executed program.
`out_truncated`	body	boolean	Indicates whether the captured standard output (stdout) was truncated due to the maximum output size limit.
`err_truncated`	body	boolean	Indicates whether the captured standard error (stderr) was truncated due to the maximum output size limit.

Status codes

Success

Code	Reason
`200 - OK`	Request was successful.

Error

Code	Reason
`401 - Unauthorized`	User must authenticate before making a request.
`403 - Forbidden`	Policy does not allow current user to do this operation.
`404 - Not Found`	The requested resource could not be found.

Example

{
  "command": {
    "created_at": "2026-03-09T11:41:11Z",
    "updated_at": "2026-03-09T11:41:12Z",
    "uuid": "9feeae99-bda2-4978-a87c-4698b9bca57f",
    "type": "file-read",
    "instance_uuid": "5a124ea0-36a0-49b8-9bd0-e937d958ca8f",
    "status": "SUCCESS",
    "error": null,
    "result": {
      "data": null
    }
  }
}