List all instances Create a new instance Get an instance by slug Delete an instance Update an instance List audit trail entries for an instance List all entitlements usage metrics Get entitlement usage metrics for an instance Report entitlement usage metric for an instance Instance Entitlement Usage Reached Webhook Instance Created Webhook Instance Deleted Webhook Instance Deployed Webhook Instance Migrated Webhook Instance Updated Webhook

Instances

Instance Entitlement Usage Reached Webhook

Triggered when an instance's entitlement usage reaches its threshold.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

Example Requests

POST/com.kaiten.instance.entitlement.v1.usage_reached

Report entitlement usage metric for an instance

Report a usage metric for a specific entitlement in a given instance. This endpoint allows you to report the usage of an entitlement, including optional metadata and a timestamp.

Instance Created Webhook

Triggered when a new instance is created.

data*

The instance entitlement usage data

name*string

Event name

Value in"INSTANCE_ENTITLEMENT_USAGE_REACHED"

type*string

Event type

Value in"com.kaiten.instance.entitlement.v1.usage_reached"