Virtual Machine

Request virtual machine logs

Requests the console logs for a specific virtual machine (VM) in Hyperstack. This endpoint initiates the process of fetching logs, and returns a request identifier that can be used to retrieve the logs. The request_id obtained from this request is then used in the Retrieve Virtual Machine Logs API to view the requested logs. A virtual machine must be in the ACTIVE state to request logs.

Async operation: This endpoint returns 202 Accepted for long-running operations. The response body includes a request_id that you can pass to the corresponding GET endpoint to poll for completion.

post/core/virtual-machines/{vm_id}/logs

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/logs
  • Auth: API key in header api_key

Path parameters

vm_idinteger required

ID of the vm.

Request body

lengthinteger

The amount of lines to fetch.

Response

Logs were successfully requested

request_idinteger

Identifier of an asynchronous request, returned by the prior POST call.

Example response

{
  "request_id": 8429
}

Changes

No recorded changes to this operation across all 1 revision of this API.