Callbacks

Attach callback to volume

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

post/core/volumes/{volume_id}/attach-callback

Request

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

Path parameters

volume_idinteger required

ID of the volume.

Request body

urlstring required

Webhook URL Hyperstack calls when the resource changes state.

Response

Callback URL successfully attached to your volume. Any action events on your volume 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.