List all instances Create a new instance Get an instance by slug Patch an instance Delete an instance Update an instance List an instance's add-ons Attach an add-on to an instance Change an instance add-on's quantity Remove an add-on from an instance List audit trail entries for an instance List an instance's entitlement exceptions Set an exception on an instance's entitlement Revoke an entitlement exception List all entitlements usage metrics Get entitlement usage metrics for an instance Report entitlement usage metric for an instance List an entitlement's usage reports for an instance Export an entitlement's usage reports for an instance Get an instance integration Create an instance integration Delete an instance integration Update an instance integration Get an instance by integration external ID Upsert an instance by integration external ID Export the organization's usage reports Instance Add-on Added Webhook Instance Add-on Quantity Changed Webhook Instance Add-on Removed Webhook Instance Entitlement Cap Exceeded Webhook Entitlement Usage Period Rolled Over Webhook Instance Entitlement Usage Reached Webhook Entitlement Usage Report Accepted Webhook Entitlement Usage Report Rejected Webhook Instance Entitlement Usage Warning Threshold Reached Webhook Instance Entitlement Value Read Webhook Instance Created Webhook Instance Deleted Webhook Instance Deployed Webhook Instance Lifecycle Stage Changed Webhook Instance Migrated Webhook Instance Status Changed Webhook Instance Updated Webhook

Instance Add-on Added Webhook

Triggered when an add-on is attached to an instance.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

Example Requests

POST/com.kaiten.instance.addon.v1.added

Export the organization's usage reports

Streams every usage report of the organization in the range, across instances and entitlements, as CSV or NDJSON, ordered by reportedAt. Filters narrow it to one instance or one entitlement, including deleted ones by ID. Use it to keep the usage history before deleting the organization.

Instance Add-on Quantity Changed Webhook

Triggered when the quantity of an instance's add-on changes.

data*

headers?

name*string

Event name

Value in"INSTANCE_ADDON_ADDED"

type*string

Event type

Value in"com.kaiten.instance.addon.v1.added"