Skip to main content
API Explorer|API Explorer
Infrastructure/Infrastructure Misc
POSTInfrastructureSince 1.0SynchronousAuth Required

Subscribe

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • targetTypeStringRequired

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

    Example: vm

  • targetUuidStringRequired

    UUID of the specific resource instance to subscribe events for

    Example: vm-abc-001

  • authTypeStringRequired

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

    Example: hmac

Responses

200 OK

On success, this API returns the following response structure.

  • callbackUrlString

    Callback URL that the event source will POST events to

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

  • authTypeString

    Authentication type configured for the callback endpoint

    Example: hmac

  • stateString

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

    Example: active

Endpoint

POST/api/v1/eventsub/subscribe

/api/v1/eventsub/subscribe

Operation ID

Subscribe

Permalink

Request Example

curl -X POST '{host}/api/v1/eventsub/subscribe' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"targetType":"vm","targetUuid":"vm-abc-001","authType":"hmac"}'

Response Example

200
{
  "callbackUrl": "https://example.com/webhook/events",
  "authType": "hmac",
  "state": "active"
}

Change History

This API has no change history records yet.

View all change history