Callbacks

Update virtual machine callback

Updates the callback URL for a specified virtual machine. Provide the new callback URL in the request body, along with the ID of the associated virtual machine in the path. For additional information on virtual machine callback URLs, see Attach callback to vm.

put/core/virtual-machines/{vm_id}/update-callback

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/update-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

Virtual machine callback URL successfully updated.

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.