Callbacks

Attach callback to virtual machine

Creates a callback URL for a specified virtual machine, enabling the posting of action events executed on the virtual machine to the specified URL. Provide the callback URL in the request body and the ID of the virtual machine to which it is being attached in the path. For more details on virtual machine callback URLs,.

post/core/virtual-machines/{vm_id}/attach-callback

Request

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

Path parameters

vm_idinteger required

ID of the vm.

Request body

urlstring required

Webhook URL Hyperstack calls when the resource changes state.

Response

Callback URL successfully attached to your virtual machine. Any action events on your virtual machine will be posted to the provided URL

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

urlstring

Webhook URL Hyperstack calls when the resource changes state.

Example response

{
  "status": true,
  "message": "Callback URL successfully attached to VM 'example-vm'. Any action events on your instance will be posted to the provided URL.",
  "url": "https://example.com/example-webhook"
}

Changes

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