Skip to main content
ZStack
Infrastructure/Infrastructure Misc

Subscribe

Subscribe to events for the specified resource target type and UUID.

POST/api/v1/eventsub/subscribe

Operation ID

Subscribe

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • targetType
    StringRequired

    Type of the target resource to subscribe events for (e.g. vm, cluster)

    Example: vm

  • targetUuid
    StringRequired

    UUID of the specific resource instance to subscribe events for

    Example: vm-abc-001

  • authType
    StringRequired

    Authentication type for the callback endpoint (hmac, token, basic)

    Example: hmac

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • callbackUrl
    String

    Callback URL that the event source will POST events to

    Example: https://example.com/webhook/events

  • authType
    String

    Authentication type configured for the callback endpoint

    Example: hmac

  • state
    String

    Current state of the subscription (active, pending, error)

    Example: active