[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6},"actionData","errors","routes/docs",{"_7":8,"_9":10,"_11":12,"_13":14},"path","api/operations/ses/index.mdx","markdownUrl","/llms.mdx/docs/api/operations/ses/content.md","preloaded",{"_3098":3099,"_3100":-7},"pageTree",{"_15":16,"_17":18},"$fumadocs_loader","page-tree","data",{"_19":20,"_21":22,"_23":20,"_24":25,"_26":-7,"_27":28,"_29":30},"type","root","$ref",{"_36":70,"_45":3097},"$id","name","Documentation","description","children",[71,72,73,74,75,76,77,78,79],"fallback",{"_19":20,"_21":31,"_23":32,"_24":33,"_26":-7,"_27":34},{"_36":70,"_45":-7},"fallback:root","Docs",[35],{"_19":36,"_24":37,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":40,"_23":41,"_21":42,"_43":-7},"folder","Api","defaultOpen","collapsible",[46],"fallback:api",{"_36":44,"_45":-7},"icon","api","meta",{"_19":36,"_24":47,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":48,"_23":49,"_21":50,"_43":-7},"Operations",[52],"fallback:api/operations",{"_36":51,"_45":-7},"api/operations",{"_19":36,"_24":53,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":54,"_23":55,"_21":56,"_43":-7},"Ses",[59,60],"fallback:api/operations/ses",{"_36":57,"_45":58},"api/operations/ses","api/operations/ses/meta.json",{"_23":67,"_19":62,"_24":53,"_26":68,"_43":-7,"_64":69,"_21":8},{"_23":61,"_19":62,"_24":63,"_26":-7,"_43":-7,"_64":65,"_21":66},"fallback:api/operations/ses/ses-bounce-and-complaint-receiver.mdx","page","SES bounce and complaint receiver (SNS) POST","url","/docs/api/operations/ses/ses-bounce-and-complaint-receiver","api/operations/ses/ses-bounce-and-complaint-receiver.mdx","fallback:api/operations/ses/index.mdx","1 operation.","/docs/api/operations/ses","",{"_23":3093,"_19":62,"_24":3094,"_26":3095,"_43":-7,"_64":3096,"_21":3093},{"_23":3089,"_19":62,"_24":3090,"_26":3091,"_43":-7,"_64":3092,"_21":3089},{"_23":3088,"_19":3027,"_43":-7,"_24":2877},{"_19":36,"_24":2877,"_20":-7,"_38":-7,"_26":3060,"_39":-7,"_27":3061,"_23":3062,"_21":3063,"_43":-7},{"_23":3058,"_19":3027,"_43":-7,"_24":3059},{"_19":36,"_24":3033,"_20":-7,"_38":-7,"_26":3034,"_39":-7,"_27":3035,"_23":3036,"_21":3037,"_43":-7},{"_23":3029,"_19":62,"_24":3030,"_26":3031,"_43":-7,"_64":3032,"_21":3029},{"_23":3026,"_19":3027,"_43":-7,"_24":3028},{"_19":36,"_24":80,"_20":-7,"_38":-7,"_26":81,"_39":-7,"_27":82,"_23":44,"_21":83,"_43":-7},"API reference","Every route the orchestrator serves, generated from the spec it ships.",[85,86,87,88,89,90,91,92,93,94,95],{"_36":44,"_45":84},"api/meta.json",{"_23":3023,"_19":62,"_24":80,"_26":3024,"_43":-7,"_64":3025,"_21":3023},{"_19":36,"_24":2723,"_20":-7,"_38":-7,"_26":2724,"_39":-7,"_27":2725,"_23":2726,"_21":2727,"_43":-7},{"_19":36,"_24":2235,"_20":-7,"_38":-7,"_26":2236,"_39":-7,"_27":2237,"_23":2238,"_21":2239,"_43":-7},{"_19":36,"_24":2090,"_20":-7,"_38":-7,"_26":2091,"_39":-7,"_27":2092,"_23":2093,"_21":2094,"_43":-7},{"_19":36,"_24":1679,"_20":-7,"_38":-7,"_26":1680,"_39":-7,"_27":1681,"_23":1682,"_21":1683,"_43":-7},{"_19":36,"_24":1625,"_20":-7,"_38":-7,"_26":1626,"_39":-7,"_27":1627,"_23":1628,"_21":1629,"_43":-7},{"_19":36,"_24":1003,"_20":-7,"_38":-7,"_26":1004,"_39":-7,"_27":1005,"_23":1006,"_21":1007,"_43":-7},{"_19":36,"_24":416,"_20":-7,"_38":-7,"_26":417,"_39":-7,"_27":418,"_23":419,"_21":420,"_43":-7},{"_19":36,"_24":342,"_20":-7,"_38":-7,"_26":343,"_39":-7,"_27":344,"_23":345,"_21":346,"_43":-7},{"_19":36,"_24":131,"_20":-7,"_38":-7,"_26":132,"_39":-7,"_27":133,"_23":134,"_21":135,"_43":-7},{"_19":36,"_24":96,"_20":-7,"_38":-7,"_26":97,"_39":-7,"_27":98,"_23":99,"_21":100,"_43":-7},"Platform","Which zone you are talking to, and the live event stream.",[102,103,104],"api/platform",{"_36":99,"_45":101},"api/platform/meta.json",{"_23":129,"_19":62,"_24":96,"_26":97,"_43":-7,"_64":130,"_21":129},{"_19":36,"_24":117,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":118,"_23":119,"_21":120,"_43":-7},{"_19":36,"_24":105,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":106,"_23":107,"_21":108,"_43":-7},"Events",[110,111],"api/platform/events",{"_36":107,"_45":109},"api/platform/events/meta.json",{"_23":115,"_19":62,"_24":105,"_26":68,"_43":-7,"_64":116,"_21":115},{"_23":112,"_19":62,"_24":113,"_26":-7,"_43":-7,"_64":114,"_21":112},"api/platform/events/websocket-event-stream.mdx","WebSocket event stream GET","/docs/api/platform/events/websocket-event-stream","api/platform/events/index.mdx","/docs/api/platform/events","Zone",[122,123],"api/platform/zone",{"_36":119,"_45":121},"api/platform/zone/meta.json",{"_23":127,"_19":62,"_24":117,"_26":68,"_43":-7,"_64":128,"_21":127},{"_23":124,"_19":62,"_24":125,"_26":-7,"_43":-7,"_64":126,"_21":124},"api/platform/zone/which-availability-zone-this-api-is-and-the.mdx","Which availability zone this API is, and the zone catalog GET","/docs/api/platform/zone/which-availability-zone-this-api-is-and-the","api/platform/zone/index.mdx","/docs/api/platform/zone","api/platform/index.mdx","/docs/api/platform","Billing and support","Credit, invoices, usage, published prices, account limits and support tickets.",[137,138,139,140,141],"api/billing",{"_36":134,"_45":136},"api/billing/meta.json",{"_23":340,"_19":62,"_24":131,"_26":132,"_43":-7,"_64":341,"_21":340},{"_19":36,"_24":207,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":208,"_23":209,"_21":210,"_43":-7},{"_19":36,"_24":195,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":196,"_23":197,"_21":198,"_43":-7},{"_19":36,"_24":183,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":184,"_23":185,"_21":186,"_43":-7},{"_19":36,"_24":142,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":143,"_23":144,"_21":145,"_43":-7},"Support tickets",[147,148,149,150,151,152,153,154,155],"api/billing/support-tickets",{"_36":144,"_45":146},"api/billing/support-tickets/meta.json",{"_23":180,"_19":62,"_24":142,"_26":181,"_43":-7,"_64":182,"_21":180},{"_23":177,"_19":62,"_24":178,"_26":-7,"_43":-7,"_64":179,"_21":177},{"_23":174,"_19":62,"_24":175,"_26":-7,"_43":-7,"_64":176,"_21":174},{"_23":171,"_19":62,"_24":172,"_26":-7,"_43":-7,"_64":173,"_21":171},{"_23":168,"_19":62,"_24":169,"_26":-7,"_43":-7,"_64":170,"_21":168},{"_23":165,"_19":62,"_24":166,"_26":-7,"_43":-7,"_64":167,"_21":165},{"_23":162,"_19":62,"_24":163,"_26":-7,"_43":-7,"_64":164,"_21":162},{"_23":159,"_19":62,"_24":160,"_26":-7,"_43":-7,"_64":161,"_21":159},{"_23":156,"_19":62,"_24":157,"_26":-7,"_43":-7,"_64":158,"_21":156},"api/billing/support-tickets/add-a-message-to-a-support-ticket.mdx","Add a message to a support ticket POST","/docs/api/billing/support-tickets/add-a-message-to-a-support-ticket","api/billing/support-tickets/list-messages-on-a-support-ticket.mdx","List messages on a support ticket GET","/docs/api/billing/support-tickets/list-messages-on-a-support-ticket","api/billing/support-tickets/close-a-support-ticket.mdx","Close a support ticket POST","/docs/api/billing/support-tickets/close-a-support-ticket","api/billing/support-tickets/delete-a-support-ticket.mdx","Delete a support ticket DELETE","/docs/api/billing/support-tickets/delete-a-support-ticket","api/billing/support-tickets/update-a-support-ticket.mdx","Update a support ticket PUT","/docs/api/billing/support-tickets/update-a-support-ticket","api/billing/support-tickets/get-a-support-ticket.mdx","Get a support ticket GET","/docs/api/billing/support-tickets/get-a-support-ticket","api/billing/support-tickets/create-a-support-ticket.mdx","Create a support ticket POST","/docs/api/billing/support-tickets/create-a-support-ticket","api/billing/support-tickets/list-support-tickets.mdx","List support tickets GET","/docs/api/billing/support-tickets/list-support-tickets","api/billing/support-tickets/index.mdx","8 operations.","/docs/api/billing/support-tickets","Limits",[188,189],"api/billing/limits",{"_36":185,"_45":187},"api/billing/limits/meta.json",{"_23":193,"_19":62,"_24":183,"_26":68,"_43":-7,"_64":194,"_21":193},{"_23":190,"_19":62,"_24":191,"_26":-7,"_43":-7,"_64":192,"_21":190},"api/billing/limits/get-the-caller-s-resource-limits.mdx","Get the caller's resource limits GET","/docs/api/billing/limits/get-the-caller-s-resource-limits","api/billing/limits/index.mdx","/docs/api/billing/limits","Pricing",[200,201],"api/billing/pricing",{"_36":197,"_45":199},"api/billing/pricing/meta.json",{"_23":205,"_19":62,"_24":195,"_26":68,"_43":-7,"_64":206,"_21":205},{"_23":202,"_19":62,"_24":203,"_26":-7,"_43":-7,"_64":204,"_21":202},"api/billing/pricing/list-pricing.mdx","List pricing GET","/docs/api/billing/pricing/list-pricing","api/billing/pricing/index.mdx","/docs/api/billing/pricing","Billing",[212,213,214,215,216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,242,243],"api/billing/billing",{"_36":209,"_45":211},"api/billing/billing/meta.json",{"_23":337,"_19":62,"_24":207,"_26":338,"_43":-7,"_64":339,"_21":337},{"_23":334,"_19":62,"_24":335,"_26":-7,"_43":-7,"_64":336,"_21":334},{"_23":331,"_19":62,"_24":332,"_26":-7,"_43":-7,"_64":333,"_21":331},{"_23":328,"_19":62,"_24":329,"_26":-7,"_43":-7,"_64":330,"_21":328},{"_23":325,"_19":62,"_24":326,"_26":-7,"_43":-7,"_64":327,"_21":325},{"_23":322,"_19":62,"_24":323,"_26":-7,"_43":-7,"_64":324,"_21":322},{"_23":319,"_19":62,"_24":320,"_26":-7,"_43":-7,"_64":321,"_21":319},{"_23":316,"_19":62,"_24":317,"_26":-7,"_43":-7,"_64":318,"_21":316},{"_23":313,"_19":62,"_24":314,"_26":-7,"_43":-7,"_64":315,"_21":313},{"_23":310,"_19":62,"_24":311,"_26":-7,"_43":-7,"_64":312,"_21":310},{"_23":307,"_19":62,"_24":308,"_26":-7,"_43":-7,"_64":309,"_21":307},{"_23":304,"_19":62,"_24":305,"_26":-7,"_43":-7,"_64":306,"_21":304},{"_23":301,"_19":62,"_24":302,"_26":-7,"_43":-7,"_64":303,"_21":301},{"_23":298,"_19":62,"_24":299,"_26":-7,"_43":-7,"_64":300,"_21":298},{"_23":295,"_19":62,"_24":296,"_26":-7,"_43":-7,"_64":297,"_21":295},{"_23":292,"_19":62,"_24":293,"_26":-7,"_43":-7,"_64":294,"_21":292},{"_23":289,"_19":62,"_24":290,"_26":-7,"_43":-7,"_64":291,"_21":289},{"_23":286,"_19":62,"_24":287,"_26":-7,"_43":-7,"_64":288,"_21":286},{"_23":283,"_19":62,"_24":284,"_26":-7,"_43":-7,"_64":285,"_21":283},{"_23":280,"_19":62,"_24":281,"_26":-7,"_43":-7,"_64":282,"_21":280},{"_23":277,"_19":62,"_24":278,"_26":-7,"_43":-7,"_64":279,"_21":277},{"_23":274,"_19":62,"_24":275,"_26":-7,"_43":-7,"_64":276,"_21":274},{"_23":271,"_19":62,"_24":272,"_26":-7,"_43":-7,"_64":273,"_21":271},{"_23":268,"_19":62,"_24":269,"_26":-7,"_43":-7,"_64":270,"_21":268},{"_23":265,"_19":62,"_24":266,"_26":-7,"_43":-7,"_64":267,"_21":265},{"_23":262,"_19":62,"_24":263,"_26":-7,"_43":-7,"_64":264,"_21":262},{"_23":259,"_19":62,"_24":260,"_26":-7,"_43":-7,"_64":261,"_21":259},{"_23":256,"_19":62,"_24":257,"_26":-7,"_43":-7,"_64":258,"_21":256},{"_23":253,"_19":62,"_24":254,"_26":-7,"_43":-7,"_64":255,"_21":253},{"_23":250,"_19":62,"_24":251,"_26":-7,"_43":-7,"_64":252,"_21":250},{"_23":247,"_19":62,"_24":248,"_26":-7,"_43":-7,"_64":249,"_21":247},{"_23":244,"_19":62,"_24":245,"_26":-7,"_43":-7,"_64":246,"_21":244},"api/billing/billing/stripe-webhook-receiver.mdx","Stripe webhook receiver POST","/docs/api/billing/billing/stripe-webhook-receiver","api/billing/billing/get-current-period-usage-aggregate.mdx","Get current-period usage aggregate GET","/docs/api/billing/billing/get-current-period-usage-aggregate","api/billing/billing/pay-a-statement-one-charge-for-every-zone-s.mdx","Pay a statement: one charge for every zone's invoice of the period POST","/docs/api/billing/billing/pay-a-statement-one-charge-for-every-zone-s","api/billing/billing/get-a-statement.mdx","Get a statement GET","/docs/api/billing/billing/get-a-statement","api/billing/billing/list-statements.mdx","List statements (one per billing period, grouping every zone's invoice) GET","/docs/api/billing/billing/list-statements","api/billing/billing/set-the-default-payment-method.mdx","Set the default payment method POST","/docs/api/billing/billing/set-the-default-payment-method","api/billing/billing/delete-a-payment-method.mdx","Delete a payment method DELETE","/docs/api/billing/billing/delete-a-payment-method","api/billing/billing/update-a-payment-method.mdx","Update a payment method PUT","/docs/api/billing/billing/update-a-payment-method","api/billing/billing/get-a-payment-method.mdx","Get a payment method GET","/docs/api/billing/billing/get-a-payment-method","api/billing/billing/create-a-payment-method.mdx","Create a payment method POST","/docs/api/billing/billing/create-a-payment-method","api/billing/billing/list-payment-methods.mdx","List payment methods GET","/docs/api/billing/billing/list-payment-methods","api/billing/billing/pay-an-invoice-from-the-tenant-s-credit-balance.mdx","Pay an invoice from the tenant's credit balance POST","/docs/api/billing/billing/pay-an-invoice-from-the-tenant-s-credit-balance","api/billing/billing/pay-an-invoice.mdx","Pay an invoice (Stripe stub) POST","/docs/api/billing/billing/pay-an-invoice","api/billing/billing/get-an-invoice.mdx","Get an invoice GET","/docs/api/billing/billing/get-an-invoice","api/billing/billing/list-invoices.mdx","List invoices GET","/docs/api/billing/billing/list-invoices","api/billing/billing/add-a-message-to-a-dispute.mdx","Add a message to a dispute POST","/docs/api/billing/billing/add-a-message-to-a-dispute","api/billing/billing/list-messages-on-a-dispute.mdx","List messages on a dispute GET","/docs/api/billing/billing/list-messages-on-a-dispute","api/billing/billing/close-a-dispute.mdx","Close a dispute POST","/docs/api/billing/billing/close-a-dispute","api/billing/billing/get-a-dispute.mdx","Get a dispute GET","/docs/api/billing/billing/get-a-dispute","api/billing/billing/create-a-dispute.mdx","Create a dispute POST","/docs/api/billing/billing/create-a-dispute","api/billing/billing/list-disputes.mdx","List disputes GET","/docs/api/billing/billing/list-disputes","api/billing/billing/get-bank-deposit-information.mdx","Get bank deposit information GET","/docs/api/billing/billing/get-bank-deposit-information","api/billing/billing/get-an-assigned-crypto-address.mdx","Get an assigned crypto address GET","/docs/api/billing/billing/get-an-assigned-crypto-address","api/billing/billing/assign-a-crypto-receive-address-to-the-caller.mdx","Assign a crypto receive address to the caller POST","/docs/api/billing/billing/assign-a-crypto-receive-address-to-the-caller","api/billing/billing/purchase-credits.mdx","Purchase credits (Stripe stub) POST","/docs/api/billing/billing/purchase-credits","api/billing/billing/get-a-credit.mdx","Get a credit GET","/docs/api/billing/billing/get-a-credit","api/billing/billing/list-credits.mdx","List credits GET","/docs/api/billing/billing/list-credits","api/billing/billing/update-a-billing-account.mdx","Update a billing account PUT","/docs/api/billing/billing/update-a-billing-account","api/billing/billing/get-a-billing-account.mdx","Get a billing account GET","/docs/api/billing/billing/get-a-billing-account","api/billing/billing/create-a-billing-account.mdx","Create a billing account POST","/docs/api/billing/billing/create-a-billing-account","api/billing/billing/list-billing-accounts.mdx","List billing accounts GET","/docs/api/billing/billing/list-billing-accounts","api/billing/billing/index.mdx","31 operations.","/docs/api/billing/billing","api/billing/index.mdx","/docs/api/billing","Managed services","Databases, caches and queues the platform runs on your behalf.",[348,349],"api/managed-services",{"_36":345,"_45":347},"api/managed-services/meta.json",{"_23":414,"_19":62,"_24":342,"_26":343,"_43":-7,"_64":415,"_21":414},{"_19":36,"_24":342,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":350,"_23":351,"_21":352,"_43":-7},[354,355,356,357,358,359,360,361,362,363,364,365,366,367,368],"api/managed-services/managed-services",{"_36":351,"_45":353},"api/managed-services/managed-services/meta.json",{"_23":411,"_19":62,"_24":342,"_26":412,"_43":-7,"_64":413,"_21":411},{"_23":408,"_19":62,"_24":409,"_26":-7,"_43":-7,"_64":410,"_21":408},{"_23":405,"_19":62,"_24":406,"_26":-7,"_43":-7,"_64":407,"_21":405},{"_23":402,"_19":62,"_24":403,"_26":-7,"_43":-7,"_64":404,"_21":402},{"_23":399,"_19":62,"_24":400,"_26":-7,"_43":-7,"_64":401,"_21":399},{"_23":396,"_19":62,"_24":397,"_26":-7,"_43":-7,"_64":398,"_21":396},{"_23":393,"_19":62,"_24":394,"_26":-7,"_43":-7,"_64":395,"_21":393},{"_23":390,"_19":62,"_24":391,"_26":-7,"_43":-7,"_64":392,"_21":390},{"_23":387,"_19":62,"_24":388,"_26":-7,"_43":-7,"_64":389,"_21":387},{"_23":384,"_19":62,"_24":385,"_26":-7,"_43":-7,"_64":386,"_21":384},{"_23":381,"_19":62,"_24":382,"_26":-7,"_43":-7,"_64":383,"_21":381},{"_23":378,"_19":62,"_24":379,"_26":-7,"_43":-7,"_64":380,"_21":378},{"_23":375,"_19":62,"_24":376,"_26":-7,"_43":-7,"_64":377,"_21":375},{"_23":372,"_19":62,"_24":373,"_26":-7,"_43":-7,"_64":374,"_21":372},{"_23":369,"_19":62,"_24":370,"_26":-7,"_43":-7,"_64":371,"_21":369},"api/managed-services/managed-services/list-all-database-backups-for-the-tenant.mdx","List all database backups for the tenant GET","/docs/api/managed-services/managed-services/list-all-database-backups-for-the-tenant","api/managed-services/managed-services/attach.mdx","Attach (enabled=true) or detach (enabled=false) a public IP on the database's load balancer PUT","/docs/api/managed-services/managed-services/attach","api/managed-services/managed-services/rotate-a-managed-service-s-admin-password.mdx","Rotate a managed service's admin password: applied to the engine, written to its Secret, and pushed into every attached workload's connection URL. Returns the new credentials POST","/docs/api/managed-services/managed-services/rotate-a-managed-service-s-admin-password","api/managed-services/managed-services/get-a-managed-service-s-live-admin-connection.mdx","Get a managed service's live admin connection credentials (endpoint, username, password) GET","/docs/api/managed-services/managed-services/get-a-managed-service-s-live-admin-connection","api/managed-services/managed-services/restore-a-database-from-a-backup-into-a-new.mdx","Restore a database from a backup into a new database POST","/docs/api/managed-services/managed-services/restore-a-database-from-a-backup-into-a-new","api/managed-services/managed-services/delete-a-database-backup.mdx","Delete a database backup DELETE","/docs/api/managed-services/managed-services/delete-a-database-backup","api/managed-services/managed-services/trigger-an-on-demand-backup.mdx","Trigger an on-demand backup POST","/docs/api/managed-services/managed-services/trigger-an-on-demand-backup","api/managed-services/managed-services/list-a-database-s-backups.mdx","List a database's backups GET","/docs/api/managed-services/managed-services/list-a-database-s-backups","api/managed-services/managed-services/update-a-database-s-backup-configuration.mdx","Update a database's backup configuration PUT","/docs/api/managed-services/managed-services/update-a-database-s-backup-configuration","api/managed-services/managed-services/delete-a-managed-service.mdx","Delete a managed service DELETE","/docs/api/managed-services/managed-services/delete-a-managed-service","api/managed-services/managed-services/update-a-managed-service.mdx","Update a managed service — including RESIZE: set instance_type to move the database onto another plan, and its cpu/memory bounds follow. Storage is expand-only and never shrinks with the plan PUT","/docs/api/managed-services/managed-services/update-a-managed-service","api/managed-services/managed-services/get-a-managed-service.mdx","Get a managed service GET","/docs/api/managed-services/managed-services/get-a-managed-service","api/managed-services/managed-services/create-a-managed-service.mdx","Create a managed service POST","/docs/api/managed-services/managed-services/create-a-managed-service","api/managed-services/managed-services/list-managed-services.mdx","List managed services GET","/docs/api/managed-services/managed-services/list-managed-services","api/managed-services/managed-services/index.mdx","14 operations.","/docs/api/managed-services/managed-services","api/managed-services/index.mdx","/docs/api/managed-services","Agents and workflows","Agent definitions, the sessions they run in, the skills and tools they may call, and the workflows that sequence them.",[422,423,424,425,426,427,428,429,430,431,432,433],"api/agents",{"_36":419,"_45":421},"api/agents/meta.json",{"_23":1001,"_19":62,"_24":416,"_26":417,"_43":-7,"_64":1002,"_21":1001},{"_19":36,"_24":977,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":978,"_23":979,"_21":980,"_43":-7},{"_19":36,"_24":904,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":905,"_23":906,"_21":907,"_43":-7},{"_19":36,"_24":875,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":876,"_23":877,"_21":878,"_43":-7},{"_19":36,"_24":782,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":783,"_23":784,"_21":785,"_43":-7},{"_19":36,"_24":770,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":771,"_23":772,"_21":773,"_43":-7},{"_19":36,"_24":726,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":727,"_23":728,"_21":729,"_43":-7},{"_19":36,"_24":686,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":687,"_23":688,"_21":689,"_43":-7},{"_19":36,"_24":641,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":642,"_23":643,"_21":644,"_43":-7},{"_19":36,"_24":560,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":561,"_23":562,"_21":563,"_43":-7},{"_19":36,"_24":459,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":460,"_23":461,"_21":462,"_43":-7},{"_19":36,"_24":434,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":435,"_23":436,"_21":437,"_43":-7},"Workflow runs",[439,440,441,442,443],"api/agents/workflow-runs",{"_36":436,"_45":438},"api/agents/workflow-runs/meta.json",{"_23":456,"_19":62,"_24":434,"_26":457,"_43":-7,"_64":458,"_21":456},{"_23":453,"_19":62,"_24":454,"_26":-7,"_43":-7,"_64":455,"_21":453},{"_23":450,"_19":62,"_24":451,"_26":-7,"_43":-7,"_64":452,"_21":450},{"_23":447,"_19":62,"_24":448,"_26":-7,"_43":-7,"_64":449,"_21":447},{"_23":444,"_19":62,"_24":445,"_26":-7,"_43":-7,"_64":446,"_21":444},"api/agents/workflow-runs/live-run-progress.mdx","Live run progress (SSE) GET","/docs/api/agents/workflow-runs/live-run-progress","api/agents/workflow-runs/cancel-a-run.mdx","Cancel a run POST","/docs/api/agents/workflow-runs/cancel-a-run","api/agents/workflow-runs/approve-or-reject-a-parked-approval-gate.mdx","Approve or reject a parked approval gate POST","/docs/api/agents/workflow-runs/approve-or-reject-a-parked-approval-gate","api/agents/workflow-runs/get-a-run-with-its-step-trail-and-the-executed.mdx","Get a run with its step trail and the executed spec GET","/docs/api/agents/workflow-runs/get-a-run-with-its-step-trail-and-the-executed","api/agents/workflow-runs/index.mdx","4 operations.","/docs/api/agents/workflow-runs","Workflows",[464,465,466,467,468,469,470,471,472,473,474,475,476,477,478,479,480,481,482,483,484,485,486,487],"api/agents/workflows",{"_36":461,"_45":463},"api/agents/workflows/meta.json",{"_23":557,"_19":62,"_24":459,"_26":558,"_43":-7,"_64":559,"_21":557},{"_23":554,"_19":62,"_24":555,"_26":-7,"_43":-7,"_64":556,"_21":554},{"_23":551,"_19":62,"_24":552,"_26":-7,"_43":-7,"_64":553,"_21":551},{"_23":548,"_19":62,"_24":549,"_26":-7,"_43":-7,"_64":550,"_21":548},{"_23":545,"_19":62,"_24":546,"_26":-7,"_43":-7,"_64":547,"_21":545},{"_23":542,"_19":62,"_24":543,"_26":-7,"_43":-7,"_64":544,"_21":542},{"_23":539,"_19":62,"_24":540,"_26":-7,"_43":-7,"_64":541,"_21":539},{"_23":536,"_19":62,"_24":537,"_26":-7,"_43":-7,"_64":538,"_21":536},{"_23":533,"_19":62,"_24":534,"_26":-7,"_43":-7,"_64":535,"_21":533},{"_23":530,"_19":62,"_24":531,"_26":-7,"_43":-7,"_64":532,"_21":530},{"_23":527,"_19":62,"_24":528,"_26":-7,"_43":-7,"_64":529,"_21":527},{"_23":524,"_19":62,"_24":525,"_26":-7,"_43":-7,"_64":526,"_21":524},{"_23":521,"_19":62,"_24":522,"_26":-7,"_43":-7,"_64":523,"_21":521},{"_23":518,"_19":62,"_24":519,"_26":-7,"_43":-7,"_64":520,"_21":518},{"_23":515,"_19":62,"_24":516,"_26":-7,"_43":-7,"_64":517,"_21":515},{"_23":512,"_19":62,"_24":513,"_26":-7,"_43":-7,"_64":514,"_21":512},{"_23":509,"_19":62,"_24":510,"_26":-7,"_43":-7,"_64":511,"_21":509},{"_23":506,"_19":62,"_24":507,"_26":-7,"_43":-7,"_64":508,"_21":506},{"_23":503,"_19":62,"_24":504,"_26":-7,"_43":-7,"_64":505,"_21":503},{"_23":500,"_19":62,"_24":501,"_26":-7,"_43":-7,"_64":502,"_21":500},{"_23":497,"_19":62,"_24":498,"_26":-7,"_43":-7,"_64":499,"_21":497},{"_23":494,"_19":62,"_24":495,"_26":-7,"_43":-7,"_64":496,"_21":494},{"_23":491,"_19":62,"_24":492,"_26":-7,"_43":-7,"_64":493,"_21":491},{"_23":488,"_19":62,"_24":489,"_26":-7,"_43":-7,"_64":490,"_21":488},"api/agents/workflows/rotate-the-webhook-signing-secret.mdx","Rotate the webhook signing secret (plaintext returned once) POST","/docs/api/agents/workflows/rotate-the-webhook-signing-secret","api/agents/workflows/get-one-published-version-s-frozen-spec.mdx","Get one published version's frozen spec GET","/docs/api/agents/workflows/get-one-published-version-s-frozen-spec","api/agents/workflows/list-published-versions.mdx","List published versions GET","/docs/api/agents/workflows/list-published-versions","api/agents/workflows/lint-a-spec.mdx","Lint a spec (full validation, nothing saved) — per-node error map POST","/docs/api/agents/workflows/lint-a-spec","api/agents/workflows/undeploy-the-workflow-s-runner-container.mdx","Undeploy the workflow's runner container (in-flight runs fail) POST","/docs/api/agents/workflows/undeploy-the-workflow-s-runner-container","api/agents/workflows/list-run-history.mdx","List run history (cursor-paginated: ?before=<timeuuid>&limit=) GET","/docs/api/agents/workflows/list-run-history","api/agents/workflows/start-a-manual-run-of-the-published-version.mdx","Start a manual run of the published version POST","/docs/api/agents/workflows/start-a-manual-run-of-the-published-version","api/agents/workflows/publish-the-draft-as-the-next-immutable-version.mdx","Publish the draft as the next immutable version (422 with per-node errors when invalid) POST","/docs/api/agents/workflows/publish-the-draft-as-the-next-immutable-version","api/agents/workflows/run-the-eval-suite-against-the-primary-or.mdx","Run the eval suite against the primary or canary deployment POST","/docs/api/agents/workflows/run-the-eval-suite-against-the-primary-or","api/agents/workflows/list-eval-verdicts.mdx","List eval verdicts (newest suites first) GET","/docs/api/agents/workflows/list-eval-verdicts","api/agents/workflows/delete-an-eval-case.mdx","Delete an eval case DELETE","/docs/api/agents/workflows/delete-an-eval-case","api/agents/workflows/create-or-update-an-eval-case.mdx","Create or update an eval case (contains / equals / LLM-judge assertion) POST","/docs/api/agents/workflows/create-or-update-an-eval-case","api/agents/workflows/list-eval-cases.mdx","List eval cases GET","/docs/api/agents/workflows/list-eval-cases","api/agents/workflows/require-a-passing-eval-suite-before-canary.mdx","Require a passing eval suite before canary promote PUT","/docs/api/agents/workflows/require-a-passing-eval-suite-before-canary","api/agents/workflows/deploy-the-published-workflow-provision-its.mdx","Deploy the published workflow: provision its tenant-side runner container POST","/docs/api/agents/workflows/deploy-the-published-workflow-provision-its","api/agents/workflows/promote-the-canary-to-primary.mdx","Promote the canary to primary (container swap; gated by require_eval_pass) POST","/docs/api/agents/workflows/promote-the-canary-to-primary","api/agents/workflows/stop-the-canary.mdx","Stop the canary (its in-flight runs fail) DELETE","/docs/api/agents/workflows/stop-the-canary","api/agents/workflows/start.mdx","Start (or reweight) a canary: a second runner pinned to another version taking weight% of new runs POST","/docs/api/agents/workflows/start","api/agents/workflows/delete-a-workflow.mdx","Delete a workflow (409 while runs are in flight) DELETE","/docs/api/agents/workflows/delete-a-workflow","api/agents/workflows/update-a-workflow-s-metadata-and-or-draft-spec.mdx","Update a workflow's metadata and/or draft spec PUT","/docs/api/agents/workflows/update-a-workflow-s-metadata-and-or-draft-spec","api/agents/workflows/get-a-workflow-with-its-draft-spec.mdx","Get a workflow with its draft spec GET","/docs/api/agents/workflows/get-a-workflow-with-its-draft-spec","api/agents/workflows/create-an-ai-workflow.mdx","Create an AI workflow (a visual DAG of inference steps) POST","/docs/api/agents/workflows/create-an-ai-workflow","api/agents/workflows/list-ai-workflows.mdx","List AI workflows GET","/docs/api/agents/workflows/list-ai-workflows","api/agents/workflows/index.mdx","23 operations.","/docs/api/agents/workflows","Workspaces",[565,566,567,568,569,570,571,572,573,574,575,576,577,578,579,580,581,582,583],"api/agents/workspaces",{"_36":562,"_45":564},"api/agents/workspaces/meta.json",{"_23":638,"_19":62,"_24":560,"_26":639,"_43":-7,"_64":640,"_21":638},{"_23":635,"_19":62,"_24":636,"_26":-7,"_43":-7,"_64":637,"_21":635},{"_23":632,"_19":62,"_24":633,"_26":-7,"_43":-7,"_64":634,"_21":632},{"_23":629,"_19":62,"_24":630,"_26":-7,"_43":-7,"_64":631,"_21":629},{"_23":626,"_19":62,"_24":627,"_26":-7,"_43":-7,"_64":628,"_21":626},{"_23":623,"_19":62,"_24":624,"_26":-7,"_43":-7,"_64":625,"_21":623},{"_23":620,"_19":62,"_24":621,"_26":-7,"_43":-7,"_64":622,"_21":620},{"_23":617,"_19":62,"_24":618,"_26":-7,"_43":-7,"_64":619,"_21":617},{"_23":614,"_19":62,"_24":615,"_26":-7,"_43":-7,"_64":616,"_21":614},{"_23":611,"_19":62,"_24":612,"_26":-7,"_43":-7,"_64":613,"_21":611},{"_23":608,"_19":62,"_24":609,"_26":-7,"_43":-7,"_64":610,"_21":608},{"_23":605,"_19":62,"_24":606,"_26":-7,"_43":-7,"_64":607,"_21":605},{"_23":602,"_19":62,"_24":603,"_26":-7,"_43":-7,"_64":604,"_21":602},{"_23":599,"_19":62,"_24":600,"_26":-7,"_43":-7,"_64":601,"_21":599},{"_23":596,"_19":62,"_24":597,"_26":-7,"_43":-7,"_64":598,"_21":596},{"_23":593,"_19":62,"_24":594,"_26":-7,"_43":-7,"_64":595,"_21":593},{"_23":590,"_19":62,"_24":591,"_26":-7,"_43":-7,"_64":592,"_21":590},{"_23":587,"_19":62,"_24":588,"_26":-7,"_43":-7,"_64":589,"_21":587},{"_23":584,"_19":62,"_24":585,"_26":-7,"_43":-7,"_64":586,"_21":584},"api/agents/workspaces/run-a-wp-cli-command-inside-a-wordpress.mdx","Run a wp-cli command inside a WordPress workspace's site (args WITHOUT the leading 'wp', e.g. ["plugin","activate","woocommerce"]). THE surface for content/config: activate plugins/themes, create pages/posts, set options, manage menus. NEVER 'wp plugin install' — plugin/theme CODE must be added to the workspace repo and pushed (the site's files are re-cloned from the repo on every deploy; installs outside the repo are LOST). POST","/docs/api/agents/workspaces/run-a-wp-cli-command-inside-a-wordpress","api/agents/workspaces/get-a-wordpress-workspace-s-wp-admin-url-admin.mdx","Get a WordPress workspace's wp-admin URL + admin credentials (SENSITIVE: contains the real password) and site URL GET","/docs/api/agents/workspaces/get-a-wordpress-workspace-s-wp-admin-url-admin","api/agents/workspaces/get-a-medusa-store-s-admin-dashboard-url-admin.mdx","Get a Medusa store's admin dashboard URL + admin credentials (SENSITIVE: contains the real password), storefront URL and publishable key GET","/docs/api/agents/workspaces/get-a-medusa-store-s-admin-dashboard-url-admin","api/agents/workspaces/read-the-running-app-s-container-log.mdx","Read the RUNNING app's container log — use this when the build succeeded but the site errors (500s, crash loops). Query: app=backend|storefront (a store has two; defaults to the storefront, which is what visitors hit), lines=1..1000 (default 200). This is the runtime log; for a build that FAILED read the deployments log instead. GET","/docs/api/agents/workspaces/read-the-running-app-s-container-log","api/agents/workspaces/enable.mdx","Enable (or retry) CI/CD on the workspace; optional deploy_server_id binds the deploy server when the workspace has none yet POST","/docs/api/agents/workspaces/enable","api/agents/workspaces/disable-the-workspace-s-push-triggered-ci-cd.mdx","Disable the workspace's push-triggered CI/CD (the Coolify app stays; re-enable resumes) POST","/docs/api/agents/workspaces/disable-the-workspace-s-push-triggered-ci-cd","api/agents/workspaces/read-the-build-log-of-the-workspace-s-most.mdx","Read the BUILD LOG of the workspace's most recent deployment. This is the first thing to read when a deploy failed — it carries the compiler/installer output that says why. For an older deploy, take its uuid from the deployments list and use the /log variant. GET","/docs/api/agents/workspaces/read-the-build-log-of-the-workspace-s-most","api/agents/workspaces/read-one-deployment-s-build-log-by-uuid.mdx","Read one deployment's BUILD LOG by uuid (from the deployments list). Use this to find out why a specific build failed before changing any code. GET","/docs/api/agents/workspaces/read-one-deployment-s-build-log-by-uuid","api/agents/workspaces/list-the-workspace-app-s-deployment-history.mdx","List the workspace app's deployment history (status + commit per deploy). A store lists BOTH apps — check the app field, since backend and storefront fail independently. GET","/docs/api/agents/workspaces/list-the-workspace-app-s-deployment-history","api/agents/workspaces/trigger-an-immediate-deploy-of-the-workspace-s.mdx","Trigger an immediate deploy of the workspace's branch head (manual release — no new commit required). Returns the refreshed CI/CD status; poll list_workspaces_id_cicd until app_status starts with 'running'. POST","/docs/api/agents/workspaces/trigger-an-immediate-deploy-of-the-workspace-s","api/agents/workspaces/get-the-workspace-s-ci-cd-status-tracked-branch.mdx","Get the workspace's CI/CD status: tracked branch, last seen/deployed sha, Coolify app status, live URL. Read this to verify a push deployed. GET","/docs/api/agents/workspaces/get-the-workspace-s-ci-cd-status-tracked-branch","api/agents/workspaces/start-a-repo-bound-chat-under-the-workspace.mdx","Start a repo-bound chat under the workspace: mode=agent spawns a single-agent run, mode=team an agent team. The repo is cloned into the agent's workspace; results ship as commits pushed to the default branch. POST","/docs/api/agents/workspaces/start-a-repo-bound-chat-under-the-workspace","api/agents/workspaces/list-a-workspace-s-chats-newest-first.mdx","List a workspace's chats newest-first (kind run|team + ref_id to open the run/team surface). Cursor: before=<seq>. GET","/docs/api/agents/workspaces/list-a-workspace-s-chats-newest-first","api/agents/workspaces/delete-a-workspace-removes-the-coolify-app.mdx","Delete a workspace: removes the Coolify app + deploy key + webhook. The GitHub repository itself is NEVER deleted. DELETE","/docs/api/agents/workspaces/delete-a-workspace-removes-the-coolify-app","api/agents/workspaces/rename-a-workspace.mdx","Rename a workspace PATCH","/docs/api/agents/workspaces/rename-a-workspace","api/agents/workspaces/get-a-workspace.mdx","Get a workspace (status creating|ready|ci_error|failed; last_error explains failures) GET","/docs/api/agents/workspaces/get-a-workspace","api/agents/workspaces/create-an-app-builder-workspace-bind-an.mdx","Create an App Builder workspace: bind an existing GitHub repository (repo_full_name) or create a fresh one (new_repo) on the connected account. With enable_cicd + deploy_server_id the platform registers a deploy key and a Coolify application so every push to the default branch auto-deploys. Requires a github connector. POST","/docs/api/agents/workspaces/create-an-app-builder-workspace-bind-an","api/agents/workspaces/list-the-tenant-s-app-builder-workspaces.mdx","List the tenant's App Builder workspaces GET","/docs/api/agents/workspaces/list-the-tenant-s-app-builder-workspaces","api/agents/workspaces/index.mdx","18 operations.","/docs/api/agents/workspaces","Retrieval",[646,647,648,649,650,651,652,653,654,655],"api/agents/rag",{"_36":643,"_45":645},"api/agents/rag/meta.json",{"_23":683,"_19":62,"_24":641,"_26":684,"_43":-7,"_64":685,"_21":683},{"_23":680,"_19":62,"_24":681,"_26":-7,"_43":-7,"_64":682,"_21":680},{"_23":677,"_19":62,"_24":678,"_26":-7,"_43":-7,"_64":679,"_21":677},{"_23":674,"_19":62,"_24":675,"_26":-7,"_43":-7,"_64":676,"_21":674},{"_23":671,"_19":62,"_24":672,"_26":-7,"_43":-7,"_64":673,"_21":671},{"_23":668,"_19":62,"_24":669,"_26":-7,"_43":-7,"_64":670,"_21":668},{"_23":665,"_19":62,"_24":666,"_26":-7,"_43":-7,"_64":667,"_21":665},{"_23":662,"_19":62,"_24":663,"_26":-7,"_43":-7,"_64":664,"_21":662},{"_23":659,"_19":62,"_24":660,"_26":-7,"_43":-7,"_64":661,"_21":659},{"_23":656,"_19":62,"_24":657,"_26":-7,"_43":-7,"_64":658,"_21":656},"api/agents/rag/enable-rag-provisions-the-tenant-s-managed.mdx","Enable RAG: provisions the tenant's managed Qdrant store on the chosen subnet POST","/docs/api/agents/rag/enable-rag-provisions-the-tenant-s-managed","api/agents/rag/disable-rag-deletes-the-store-collections-and.mdx","Disable RAG: deletes the store, collections and documents POST","/docs/api/agents/rag/disable-rag-deletes-the-store-collections-and","api/agents/rag/delete-a-document.mdx","Delete a document (its vectors are removed) DELETE","/docs/api/agents/rag/delete-a-document","api/agents/rag/upload-a-document.mdx","Upload a document (text or base64 pdf/txt/md/json/csv): extracted, chunked, embedded, indexed POST","/docs/api/agents/rag/upload-a-document","api/agents/rag/list-a-collection-s-documents.mdx","List a collection's documents GET","/docs/api/agents/rag/list-a-collection-s-documents","api/agents/rag/delete-a-rag-collection-and-its-documents.mdx","Delete a RAG collection and its documents DELETE","/docs/api/agents/rag/delete-a-rag-collection-and-its-documents","api/agents/rag/create-a-rag-collection.mdx","Create a RAG collection POST","/docs/api/agents/rag/create-a-rag-collection","api/agents/rag/list-rag-collections.mdx","List RAG collections GET","/docs/api/agents/rag/list-rag-collections","api/agents/rag/rag-store-status.mdx","RAG store status (enabled, ready, endpoint) GET","/docs/api/agents/rag/rag-store-status","api/agents/rag/index.mdx","9 operations.","/docs/api/agents/rag","Tools",[691,692,693,694,695,696,697,698,699],"api/agents/tools",{"_36":688,"_45":690},"api/agents/tools/meta.json",{"_23":724,"_19":62,"_24":686,"_26":181,"_43":-7,"_64":725,"_21":724},{"_23":721,"_19":62,"_24":722,"_26":-7,"_43":-7,"_64":723,"_21":721},{"_23":718,"_19":62,"_24":719,"_26":-7,"_43":-7,"_64":720,"_21":718},{"_23":715,"_19":62,"_24":716,"_26":-7,"_43":-7,"_64":717,"_21":715},{"_23":712,"_19":62,"_24":713,"_26":-7,"_43":-7,"_64":714,"_21":712},{"_23":709,"_19":62,"_24":710,"_26":-7,"_43":-7,"_64":711,"_21":709},{"_23":706,"_19":62,"_24":707,"_26":-7,"_43":-7,"_64":708,"_21":706},{"_23":703,"_19":62,"_24":704,"_26":-7,"_43":-7,"_64":705,"_21":703},{"_23":700,"_19":62,"_24":701,"_26":-7,"_43":-7,"_64":702,"_21":700},"api/agents/tools/whether-tool-credential-storage-is-configured.mdx","Whether tool credential storage is configured GET","/docs/api/agents/tools/whether-tool-credential-storage-is-configured","api/agents/tools/test-a-tool-s-stored-credential.mdx","Test a tool's stored credential (structural check, plus an optional reachability probe when test_url is provided) POST","/docs/api/agents/tools/test-a-tool-s-stored-credential","api/agents/tools/list-the-tools-advertised-by-this-mcp-server.mdx","List the tools advertised by this MCP server (live tools/list probe) GET","/docs/api/agents/tools/list-the-tools-advertised-by-this-mcp-server","api/agents/tools/delete-a-tool.mdx","Delete a tool DELETE","/docs/api/agents/tools/delete-a-tool","api/agents/tools/update-a-tool.mdx","Update a tool PUT","/docs/api/agents/tools/update-a-tool","api/agents/tools/get-a-tool.mdx","Get a tool GET","/docs/api/agents/tools/get-a-tool","api/agents/tools/create-a-tool.mdx","Create a tool POST","/docs/api/agents/tools/create-a-tool","api/agents/tools/list-tools.mdx","List tools GET","/docs/api/agents/tools/list-tools","api/agents/tools/index.mdx","/docs/api/agents/tools","Skills",[731,732,733,734,735,736,737,738,739,740],"api/agents/skills",{"_36":728,"_45":730},"api/agents/skills/meta.json",{"_23":768,"_19":62,"_24":726,"_26":684,"_43":-7,"_64":769,"_21":768},{"_23":765,"_19":62,"_24":766,"_26":-7,"_43":-7,"_64":767,"_21":765},{"_23":762,"_19":62,"_24":763,"_26":-7,"_43":-7,"_64":764,"_21":762},{"_23":759,"_19":62,"_24":760,"_26":-7,"_43":-7,"_64":761,"_21":759},{"_23":756,"_19":62,"_24":757,"_26":-7,"_43":-7,"_64":758,"_21":756},{"_23":753,"_19":62,"_24":754,"_26":-7,"_43":-7,"_64":755,"_21":753},{"_23":750,"_19":62,"_24":751,"_26":-7,"_43":-7,"_64":752,"_21":750},{"_23":747,"_19":62,"_24":748,"_26":-7,"_43":-7,"_64":749,"_21":747},{"_23":744,"_19":62,"_24":745,"_26":-7,"_43":-7,"_64":746,"_21":744},{"_23":741,"_19":62,"_24":742,"_26":-7,"_43":-7,"_64":743,"_21":741},"api/agents/skills/read-a-skill-file-s-content.mdx","Read a skill file's content GET","/docs/api/agents/skills/read-a-skill-file-s-content","api/agents/skills/delete-a-skill-file.mdx","Delete a skill file DELETE","/docs/api/agents/skills/delete-a-skill-file","api/agents/skills/create-or-replace-a-skill-file.mdx","Create or replace a skill file PUT","/docs/api/agents/skills/create-or-replace-a-skill-file","api/agents/skills/list-a-skill-s-files.mdx","List a skill's files GET","/docs/api/agents/skills/list-a-skill-s-files","api/agents/skills/delete-a-skill.mdx","Delete a skill DELETE","/docs/api/agents/skills/delete-a-skill","api/agents/skills/update-a-skill.mdx","Update a skill PUT","/docs/api/agents/skills/update-a-skill","api/agents/skills/get-a-skill.mdx","Get a skill GET","/docs/api/agents/skills/get-a-skill","api/agents/skills/create-a-skill.mdx","Create a skill POST","/docs/api/agents/skills/create-a-skill","api/agents/skills/list-skills.mdx","List skills GET","/docs/api/agents/skills/list-skills","api/agents/skills/index.mdx","/docs/api/agents/skills","Team agents",[775,776],"api/agents/team-agents",{"_36":772,"_45":774},"api/agents/team-agents/meta.json",{"_23":780,"_19":62,"_24":770,"_26":68,"_43":-7,"_64":781,"_21":780},{"_23":777,"_19":62,"_24":778,"_26":-7,"_43":-7,"_64":779,"_21":777},"api/agents/team-agents/list-your-teammate-agents.mdx","List your teammate agents GET","/docs/api/agents/team-agents/list-your-teammate-agents","api/agents/team-agents/index.mdx","/docs/api/agents/team-agents","Agent sessions",[787,788,789,790,791,792,793,794,795,796,797,798,799,800,801,802,803,804,805,806,807,808],"api/agents/agent-sessions",{"_36":784,"_45":786},"api/agents/agent-sessions/meta.json",{"_23":872,"_19":62,"_24":782,"_26":873,"_43":-7,"_64":874,"_21":872},{"_23":869,"_19":62,"_24":870,"_26":-7,"_43":-7,"_64":871,"_21":869},{"_23":866,"_19":62,"_24":867,"_26":-7,"_43":-7,"_64":868,"_21":866},{"_23":863,"_19":62,"_24":864,"_26":-7,"_43":-7,"_64":865,"_21":863},{"_23":860,"_19":62,"_24":861,"_26":-7,"_43":-7,"_64":862,"_21":860},{"_23":857,"_19":62,"_24":858,"_26":-7,"_43":-7,"_64":859,"_21":857},{"_23":854,"_19":62,"_24":855,"_26":-7,"_43":-7,"_64":856,"_21":854},{"_23":851,"_19":62,"_24":852,"_26":-7,"_43":-7,"_64":853,"_21":851},{"_23":848,"_19":62,"_24":849,"_26":-7,"_43":-7,"_64":850,"_21":848},{"_23":845,"_19":62,"_24":846,"_26":-7,"_43":-7,"_64":847,"_21":845},{"_23":842,"_19":62,"_24":843,"_26":-7,"_43":-7,"_64":844,"_21":842},{"_23":839,"_19":62,"_24":840,"_26":-7,"_43":-7,"_64":841,"_21":839},{"_23":836,"_19":62,"_24":837,"_26":-7,"_43":-7,"_64":838,"_21":836},{"_23":833,"_19":62,"_24":834,"_26":-7,"_43":-7,"_64":835,"_21":833},{"_23":830,"_19":62,"_24":831,"_26":-7,"_43":-7,"_64":832,"_21":830},{"_23":827,"_19":62,"_24":828,"_26":-7,"_43":-7,"_64":829,"_21":827},{"_23":824,"_19":62,"_24":825,"_26":-7,"_43":-7,"_64":826,"_21":824},{"_23":821,"_19":62,"_24":822,"_26":-7,"_43":-7,"_64":823,"_21":821},{"_23":818,"_19":62,"_24":819,"_26":-7,"_43":-7,"_64":820,"_21":818},{"_23":815,"_19":62,"_24":816,"_26":-7,"_43":-7,"_64":817,"_21":815},{"_23":812,"_19":62,"_24":813,"_26":-7,"_43":-7,"_64":814,"_21":812},{"_23":809,"_19":62,"_24":810,"_26":-7,"_43":-7,"_64":811,"_21":809},"api/agents/agent-sessions/browse-the-github-connector-s-repositories.mdx","Browse the GitHub connector's repositories — the ADD-repository dialog's source (409 connector_required when none) GET","/docs/api/agents/agent-sessions/browse-the-github-connector-s-repositories","api/agents/agent-sessions/reset-session-memory.mdx","Reset session memory — one file (?file=) or the whole repository (files + recaps) DELETE","/docs/api/agents/agent-sessions/reset-session-memory","api/agents/agent-sessions/edit-one-session-memory-file.mdx","Edit one session-memory file (human curation; empty content deletes the file) PUT","/docs/api/agents/agent-sessions/edit-one-session-memory-file","api/agents/agent-sessions/browse-per-repository-session-memory.mdx","Browse per-repository session memory (living docs distilled from wrapped sessions) GET","/docs/api/agents/agent-sessions/browse-per-repository-session-memory","api/agents/agent-sessions/session-model-reasoning-effort-choices-from-the.mdx","Session model + reasoning-effort choices from the CLI's own vocabulary GET","/docs/api/agents/agent-sessions/session-model-reasoning-effort-choices-from-the","api/agents/agent-sessions/list-a-repository-s-branches.mdx","List a repository's branches (default branch flagged first) for the session branch picker GET","/docs/api/agents/agent-sessions/list-a-repository-s-branches","api/agents/agent-sessions/session-usage-context-window-footprint-provider.mdx","Session usage: context-window footprint + provider subscription limits GET","/docs/api/agents/agent-sessions/session-usage-context-window-footprint-provider","api/agents/agent-sessions/interactive-terminal-into-the-session-sandbox.mdx","Interactive terminal into the session sandbox (WebSocket) GET","/docs/api/agents/agent-sessions/interactive-terminal-into-the-session-sandbox","api/agents/agent-sessions/session-live-output-stream.mdx","Session live-output stream (SSE) GET","/docs/api/agents/agent-sessions/session-live-output-stream","api/agents/agent-sessions/resume-a-paused-agent-session.mdx","Resume a paused agent session POST","/docs/api/agents/agent-sessions/resume-a-paused-agent-session","api/agents/agent-sessions/pause-an-agent-session.mdx","Pause an agent session (snapshots + frees the sandbox; a message wakes it) POST","/docs/api/agents/agent-sessions/pause-an-agent-session","api/agents/agent-sessions/send-a-user-turn-to-the-session-s-cli-agent.mdx","Send a user turn to the session's CLI agent (wakes a paused session) POST","/docs/api/agents/agent-sessions/send-a-user-turn-to-the-session-s-cli-agent","api/agents/agent-sessions/read-the-session-conversation.mdx","Read the session conversation (cursor-paged; pass next as ?after=) GET","/docs/api/agents/agent-sessions/read-the-session-conversation","api/agents/agent-sessions/stop-the-running-turn-only.mdx","Stop the running turn only (the composer stop button) — sandbox and conversation stay alive POST","/docs/api/agents/agent-sessions/stop-the-running-turn-only","api/agents/agent-sessions/end-a-background-shell-the-agent-started.mdx","End a background shell the agent started (a Bash run in the background), by its command; the turn keeps running POST","/docs/api/agents/agent-sessions/end-a-background-shell-the-agent-started","api/agents/agent-sessions/submit-the-cli-oauth-code-shown-after-opening.mdx","Submit the CLI OAuth code shown after opening the session's auth link POST","/docs/api/agents/agent-sessions/submit-the-cli-oauth-code-shown-after-opening","api/agents/agent-sessions/destroy-an-agent-session.mdx","Destroy an agent session (tears down the sandbox and deletes the conversation) DELETE","/docs/api/agents/agent-sessions/destroy-an-agent-session","api/agents/agent-sessions/update-an-agent-session-s-settings.mdx","Update an agent session's settings (title, model, idle window) PUT","/docs/api/agents/agent-sessions/update-an-agent-session-s-settings","api/agents/agent-sessions/get-an-agent-session.mdx","Get an agent session (state, online, auth link, queued turns) GET","/docs/api/agents/agent-sessions/get-an-agent-session","api/agents/agent-sessions/spawn-an-interactive-claude-code-codex-agent.mdx","Spawn an interactive Claude Code / Codex agent session (its own microVM sandbox) POST","/docs/api/agents/agent-sessions/spawn-an-interactive-claude-code-codex-agent","api/agents/agent-sessions/list-agent-sessions.mdx","List agent sessions (live status, repo, harness) GET","/docs/api/agents/agent-sessions/list-agent-sessions","api/agents/agent-sessions/index.mdx","21 operations.","/docs/api/agents/agent-sessions","Agent roles",[880,881,882,883,884,885],"api/agents/agent-roles",{"_36":877,"_45":879},"api/agents/agent-roles/meta.json",{"_23":901,"_19":62,"_24":875,"_26":902,"_43":-7,"_64":903,"_21":901},{"_23":898,"_19":62,"_24":899,"_26":-7,"_43":-7,"_64":900,"_21":898},{"_23":895,"_19":62,"_24":896,"_26":-7,"_43":-7,"_64":897,"_21":895},{"_23":892,"_19":62,"_24":893,"_26":-7,"_43":-7,"_64":894,"_21":892},{"_23":889,"_19":62,"_24":890,"_26":-7,"_43":-7,"_64":891,"_21":889},{"_23":886,"_19":62,"_24":887,"_26":-7,"_43":-7,"_64":888,"_21":886},"api/agents/agent-roles/delete-a-custom-agent-role.mdx","Delete a custom agent role DELETE","/docs/api/agents/agent-roles/delete-a-custom-agent-role","api/agents/agent-roles/update-a-custom-agent-role.mdx","Update a custom agent role (builtins are immutable; running runs keep their frozen copy) PUT","/docs/api/agents/agent-roles/update-a-custom-agent-role","api/agents/agent-roles/get-a-custom-agent-role.mdx","Get a custom agent role GET","/docs/api/agents/agent-roles/get-a-custom-agent-role","api/agents/agent-roles/create-a-custom-agent-role.mdx","Create a custom agent role (a persona assignable to runs and team members) POST","/docs/api/agents/agent-roles/create-a-custom-agent-role","api/agents/agent-roles/list-agent-roles.mdx","List agent roles (builtin lead/coder/reviewer/researcher + this tenant's custom roles) GET","/docs/api/agents/agent-roles/list-agent-roles","api/agents/agent-roles/index.mdx","5 operations.","/docs/api/agents/agent-roles","Teams",[909,910,911,912,913,914,915,916,917,918,919,920,921,922,923,924,925],"api/agents/teams",{"_36":906,"_45":908},"api/agents/teams/meta.json",{"_23":974,"_19":62,"_24":904,"_26":975,"_43":-7,"_64":976,"_21":974},{"_23":971,"_19":62,"_24":972,"_26":-7,"_43":-7,"_64":973,"_21":971},{"_23":968,"_19":62,"_24":969,"_26":-7,"_43":-7,"_64":970,"_21":968},{"_23":965,"_19":62,"_24":966,"_26":-7,"_43":-7,"_64":967,"_21":965},{"_23":962,"_19":62,"_24":963,"_26":-7,"_43":-7,"_64":964,"_21":962},{"_23":959,"_19":62,"_24":960,"_26":-7,"_43":-7,"_64":961,"_21":959},{"_23":956,"_19":62,"_24":957,"_26":-7,"_43":-7,"_64":958,"_21":956},{"_23":953,"_19":62,"_24":954,"_26":-7,"_43":-7,"_64":955,"_21":953},{"_23":950,"_19":62,"_24":951,"_26":-7,"_43":-7,"_64":952,"_21":950},{"_23":947,"_19":62,"_24":948,"_26":-7,"_43":-7,"_64":949,"_21":947},{"_23":944,"_19":62,"_24":945,"_26":-7,"_43":-7,"_64":946,"_21":944},{"_23":941,"_19":62,"_24":942,"_26":-7,"_43":-7,"_64":943,"_21":941},{"_23":938,"_19":62,"_24":939,"_26":-7,"_43":-7,"_64":940,"_21":938},{"_23":935,"_19":62,"_24":936,"_26":-7,"_43":-7,"_64":937,"_21":935},{"_23":932,"_19":62,"_24":933,"_26":-7,"_43":-7,"_64":934,"_21":932},{"_23":929,"_19":62,"_24":930,"_26":-7,"_43":-7,"_64":931,"_21":929},{"_23":926,"_19":62,"_24":927,"_26":-7,"_43":-7,"_64":928,"_21":926},"api/agents/teams/team-live-output-stream.mdx","Team live-output stream (SSE) GET","/docs/api/agents/teams/team-live-output-stream","api/agents/teams/stop-an-agent-team.mdx","Stop an agent team (tears down member runs; keeps the conversation log) POST","/docs/api/agents/teams/stop-an-agent-team","api/agents/teams/re-deliver-the-lead-s-last-task-exactly-as.mdx","Re-deliver the lead's last task exactly as originally sent (after a failure) POST","/docs/api/agents/teams/re-deliver-the-lead-s-last-task-exactly-as","api/agents/teams/approve-a-planning-team-s-proposed-roster.mdx","Approve a planning team's proposed roster (optionally edited) and launch it POST","/docs/api/agents/teams/approve-a-planning-team-s-proposed-roster","api/agents/teams/pause-an-agent-team.mdx","Pause an agent team (snapshots + frees member VMs; the next chat message wakes it) POST","/docs/api/agents/teams/pause-an-agent-team","api/agents/teams/read-the-team-conversation-log.mdx","Read the team conversation log (cursor-paged; pass next as ?after=) GET","/docs/api/agents/teams/read-the-team-conversation-log","api/agents/teams/interactive-terminal-into-a-team-member-s.mdx","Interactive terminal into a team member's sandbox (WebSocket) GET","/docs/api/agents/teams/interactive-terminal-into-a-team-member-s","api/agents/teams/stop-the-running-task-only.mdx","Stop the running task only (the composer stop button) — members and conversation stay alive POST","/docs/api/agents/teams/stop-the-running-task-only","api/agents/teams/download-a-file-an-agent-shared-from-the-team-s.mdx","Download a file an agent shared from the team's storage GET","/docs/api/agents/teams/download-a-file-an-agent-shared-from-the-team-s","api/agents/teams/send-a-chat-message-to-the-team-s-lead-agent.mdx","Send a chat message to the team's lead agent POST","/docs/api/agents/teams/send-a-chat-message-to-the-team-s-lead-agent","api/agents/teams/archive-an-agent-team.mdx","Archive an agent team (deletes member VMs for good; keeps the conversation log) POST","/docs/api/agents/teams/archive-an-agent-team","api/agents/teams/delete-an-agent-team-and-its-conversation-log.mdx","Delete an agent team and its conversation log DELETE","/docs/api/agents/teams/delete-an-agent-team-and-its-conversation-log","api/agents/teams/update-an-agent-team-s-settings.mdx","Update an agent team's settings (name, model, budgets) PUT","/docs/api/agents/teams/update-an-agent-team-s-settings","api/agents/teams/get-an-agent-team.mdx","Get an agent team (members + live online state) GET","/docs/api/agents/teams/get-an-agent-team","api/agents/teams/spawn-an-agent-team.mdx","Spawn an agent team (role-assigned agents that collaborate on a task) POST","/docs/api/agents/teams/spawn-an-agent-team","api/agents/teams/list-agent-teams.mdx","List agent teams GET","/docs/api/agents/teams/list-agent-teams","api/agents/teams/index.mdx","16 operations.","/docs/api/agents/teams","Agents",[982,983,984,985,986],"api/agents/agents",{"_36":979,"_45":981},"api/agents/agents/meta.json",{"_23":999,"_19":62,"_24":977,"_26":457,"_43":-7,"_64":1000,"_21":999},{"_23":996,"_19":62,"_24":997,"_26":-7,"_43":-7,"_64":998,"_21":996},{"_23":993,"_19":62,"_24":994,"_26":-7,"_43":-7,"_64":995,"_21":993},{"_23":990,"_19":62,"_24":991,"_26":-7,"_43":-7,"_64":992,"_21":990},{"_23":987,"_19":62,"_24":988,"_26":-7,"_43":-7,"_64":989,"_21":987},"api/agents/agents/delegate-an-autonomous-task-to-an-agent-runtime.mdx","Delegate an autonomous task to an agent-runtime agent and wait for its answer POST","/docs/api/agents/agents/delegate-an-autonomous-task-to-an-agent-runtime","api/agents/agents/send-a-shell-command-to-an-agent-and-wait-for.mdx","Send a shell command to an agent and wait for the result POST","/docs/api/agents/agents/send-a-shell-command-to-an-agent-and-wait-for","api/agents/agents/get-an-in-guest-agent.mdx","Get an in-guest agent GET","/docs/api/agents/agents/get-an-in-guest-agent","api/agents/agents/list-in-guest-agents.mdx","List in-guest agents GET","/docs/api/agents/agents/list-in-guest-agents","api/agents/agents/index.mdx","/docs/api/agents/agents","api/agents/index.mdx","/docs/api/agents","Applications","Deploying from a Git repository: build servers, environments, connectors, runs and the webhooks that trigger them.",[1009,1010,1011,1012,1013,1014,1015,1016,1017,1018],"api/applications",{"_36":1006,"_45":1008},"api/applications/meta.json",{"_23":1623,"_19":62,"_24":1003,"_26":1004,"_43":-7,"_64":1624,"_21":1623},{"_19":36,"_24":1003,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1455,"_23":1456,"_21":1457,"_43":-7},{"_19":36,"_24":1222,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1223,"_23":1224,"_21":1225,"_43":-7},{"_19":36,"_24":1198,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1199,"_23":1200,"_21":1201,"_43":-7},{"_19":36,"_24":1165,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1166,"_23":1167,"_21":1168,"_43":-7},{"_19":36,"_24":1121,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1122,"_23":1123,"_21":1124,"_43":-7},{"_19":36,"_24":1077,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1078,"_23":1079,"_21":1080,"_43":-7},{"_19":36,"_24":1057,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1058,"_23":1059,"_21":1060,"_43":-7},{"_19":36,"_24":1040,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1041,"_23":1042,"_21":1043,"_43":-7},{"_19":36,"_24":1019,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1020,"_23":1021,"_21":1022,"_43":-7},"Webhooks",[1024,1025,1026,1027],"api/applications/webhooks",{"_36":1021,"_45":1023},"api/applications/webhooks/meta.json",{"_23":1037,"_19":62,"_24":1019,"_26":1038,"_43":-7,"_64":1039,"_21":1037},{"_23":1034,"_19":62,"_24":1035,"_26":-7,"_43":-7,"_64":1036,"_21":1034},{"_23":1031,"_19":62,"_24":1032,"_26":-7,"_43":-7,"_64":1033,"_21":1031},{"_23":1028,"_19":62,"_24":1029,"_26":-7,"_43":-7,"_64":1030,"_21":1028},"api/applications/webhooks/public-workflow-webhook-trigger.mdx","Public workflow webhook trigger (HMAC-SHA256 over the raw body in X-Signature-256) POST","/docs/api/applications/webhooks/public-workflow-webhook-trigger","api/applications/webhooks/github-push-webhook-receiver.mdx","GitHub push webhook receiver (Applications) POST","/docs/api/applications/webhooks/github-push-webhook-receiver","api/applications/webhooks/github-push-webhook-receiver-post.mdx","GitHub push webhook receiver (App Builder workspaces) POST","/docs/api/applications/webhooks/github-push-webhook-receiver-post","api/applications/webhooks/index.mdx","3 operations.","/docs/api/applications/webhooks","GitHub",[1045,1046,1047],"api/applications/github",{"_36":1042,"_45":1044},"api/applications/github/meta.json",{"_23":1054,"_19":62,"_24":1040,"_26":1055,"_43":-7,"_64":1056,"_21":1054},{"_23":1051,"_19":62,"_24":1052,"_26":-7,"_43":-7,"_64":1053,"_21":1051},{"_23":1048,"_19":62,"_24":1049,"_26":-7,"_43":-7,"_64":1050,"_21":1048},"api/applications/github/create-a-repository-on-the-connected-github.mdx","Create a repository on the connected GitHub account (auto-initialized so it has a default branch) POST","/docs/api/applications/github/create-a-repository-on-the-connected-github","api/applications/github/list-the-connected-github-account-s-repositories.mdx","List the connected GitHub account's repositories (most recently pushed first) — the workspace repo picker. Optional connector_id (defaults to the tenant's default github connector), page, per_page. GET","/docs/api/applications/github/list-the-connected-github-account-s-repositories","api/applications/github/index.mdx","2 operations.","/docs/api/applications/github","Repos",[1062,1063,1064,1065],"api/applications/repos",{"_36":1059,"_45":1061},"api/applications/repos/meta.json",{"_23":1075,"_19":62,"_24":1057,"_26":1038,"_43":-7,"_64":1076,"_21":1075},{"_23":1072,"_19":62,"_24":1073,"_26":-7,"_43":-7,"_64":1074,"_21":1072},{"_23":1069,"_19":62,"_24":1070,"_26":-7,"_43":-7,"_64":1071,"_21":1069},{"_23":1066,"_19":62,"_24":1067,"_26":-7,"_43":-7,"_64":1068,"_21":1066},"api/applications/repos/remove-a-registered-repository.mdx","Remove a registered repository (existing sessions keep working) DELETE","/docs/api/applications/repos/remove-a-registered-repository","api/applications/repos/register-a-repository.mdx","Register a repository (validated through the GitHub connector; idempotent) POST","/docs/api/applications/repos/register-a-repository","api/applications/repos/list-the-tenant-s-registered-repositories.mdx","List the tenant's registered repositories (what session creation and @repo mentions offer) GET","/docs/api/applications/repos/list-the-tenant-s-registered-repositories","api/applications/repos/index.mdx","/docs/api/applications/repos","Runs",[1082,1083,1084,1085,1086,1087,1088,1089,1090,1091],"api/applications/runs",{"_36":1079,"_45":1081},"api/applications/runs/meta.json",{"_23":1119,"_19":62,"_24":1077,"_26":684,"_43":-7,"_64":1120,"_21":1119},{"_23":1116,"_19":62,"_24":1117,"_26":-7,"_43":-7,"_64":1118,"_21":1116},{"_23":1113,"_19":62,"_24":1114,"_26":-7,"_43":-7,"_64":1115,"_21":1113},{"_23":1110,"_19":62,"_24":1111,"_26":-7,"_43":-7,"_64":1112,"_21":1110},{"_23":1107,"_19":62,"_24":1108,"_26":-7,"_43":-7,"_64":1109,"_21":1107},{"_23":1104,"_19":62,"_24":1105,"_26":-7,"_43":-7,"_64":1106,"_21":1104},{"_23":1101,"_19":62,"_24":1102,"_26":-7,"_43":-7,"_64":1103,"_21":1101},{"_23":1098,"_19":62,"_24":1099,"_26":-7,"_43":-7,"_64":1100,"_21":1098},{"_23":1095,"_19":62,"_24":1096,"_26":-7,"_43":-7,"_64":1097,"_21":1095},{"_23":1092,"_19":62,"_24":1093,"_26":-7,"_43":-7,"_64":1094,"_21":1092},"api/applications/runs/stop-a-run.mdx","Stop a run POST","/docs/api/applications/runs/stop-a-run","api/applications/runs/resume-a-run.mdx","Resume a run POST","/docs/api/applications/runs/resume-a-run","api/applications/runs/promote-a-run-into-a-new-environment.mdx","Promote a run into a new environment POST","/docs/api/applications/runs/promote-a-run-into-a-new-environment","api/applications/runs/pause-a-run.mdx","Pause a run POST","/docs/api/applications/runs/pause-a-run","api/applications/runs/delete-a-run.mdx","Delete a run DELETE","/docs/api/applications/runs/delete-a-run","api/applications/runs/update-a-run.mdx","Update a run (rename, tags) PUT","/docs/api/applications/runs/update-a-run","api/applications/runs/get-a-run.mdx","Get a run GET","/docs/api/applications/runs/get-a-run","api/applications/runs/create-a-run-from-a-sealed-pool.mdx","Create a run from a sealed pool POST","/docs/api/applications/runs/create-a-run-from-a-sealed-pool","api/applications/runs/list-runs.mdx","List runs GET","/docs/api/applications/runs/list-runs","api/applications/runs/index.mdx","/docs/api/applications/runs","Connectors",[1126,1127,1128,1129,1130,1131,1132,1133,1134,1135],"api/applications/connectors",{"_36":1123,"_45":1125},"api/applications/connectors/meta.json",{"_23":1163,"_19":62,"_24":1121,"_26":684,"_43":-7,"_64":1164,"_21":1163},{"_23":1160,"_19":62,"_24":1161,"_26":-7,"_43":-7,"_64":1162,"_21":1160},{"_23":1157,"_19":62,"_24":1158,"_26":-7,"_43":-7,"_64":1159,"_21":1157},{"_23":1154,"_19":62,"_24":1155,"_26":-7,"_43":-7,"_64":1156,"_21":1154},{"_23":1151,"_19":62,"_24":1152,"_26":-7,"_43":-7,"_64":1153,"_21":1151},{"_23":1148,"_19":62,"_24":1149,"_26":-7,"_43":-7,"_64":1150,"_21":1148},{"_23":1145,"_19":62,"_24":1146,"_26":-7,"_43":-7,"_64":1147,"_21":1145},{"_23":1142,"_19":62,"_24":1143,"_26":-7,"_43":-7,"_64":1144,"_21":1142},{"_23":1139,"_19":62,"_24":1140,"_26":-7,"_43":-7,"_64":1141,"_21":1139},{"_23":1136,"_19":62,"_24":1137,"_26":-7,"_43":-7,"_64":1138,"_21":1136},"api/applications/connectors/start-a-connector-oauth-wizard.mdx","Start a connector OAuth wizard (returns the authorize URL to open) POST","/docs/api/applications/connectors/start-a-connector-oauth-wizard","api/applications/connectors/complete-a-connector-oauth-wizard.mdx","Complete a connector OAuth wizard (exchange the pasted code) POST","/docs/api/applications/connectors/complete-a-connector-oauth-wizard","api/applications/connectors/import-a-directly-supplied-api-key-as-a.mdx","Import a directly-supplied API key as a connector (connector_id replaces an existing connector's key in place) POST","/docs/api/applications/connectors/import-a-directly-supplied-api-key-as-a","api/applications/connectors/start-a-device-authorization-connector-login.mdx","Start a device-authorization connector login (returns user code + verification URL) POST","/docs/api/applications/connectors/start-a-device-authorization-connector-login","api/applications/connectors/poll-a-pending-device-login.mdx","Poll a pending device login (status pending until approved, then done + connector) POST","/docs/api/applications/connectors/poll-a-pending-device-login","api/applications/connectors/make-a-connector-the-default-for-its-provider.mdx","Make a connector the default for its provider POST","/docs/api/applications/connectors/make-a-connector-the-default-for-its-provider","api/applications/connectors/delete-a-connector.mdx","Delete a connector DELETE","/docs/api/applications/connectors/delete-a-connector","api/applications/connectors/rename-a-connector.mdx","Rename a connector PATCH","/docs/api/applications/connectors/rename-a-connector","api/applications/connectors/list-agent-cli-connectors.mdx","List agent CLI connectors (credential sets, never the tokens) GET","/docs/api/applications/connectors/list-agent-cli-connectors","api/applications/connectors/index.mdx","/docs/api/applications/connectors","Environments",[1170,1171,1172,1173,1174,1175,1176],"api/applications/environments",{"_36":1167,"_45":1169},"api/applications/environments/meta.json",{"_23":1195,"_19":62,"_24":1165,"_26":1196,"_43":-7,"_64":1197,"_21":1195},{"_23":1192,"_19":62,"_24":1193,"_26":-7,"_43":-7,"_64":1194,"_21":1192},{"_23":1189,"_19":62,"_24":1190,"_26":-7,"_43":-7,"_64":1191,"_21":1189},{"_23":1186,"_19":62,"_24":1187,"_26":-7,"_43":-7,"_64":1188,"_21":1186},{"_23":1183,"_19":62,"_24":1184,"_26":-7,"_43":-7,"_64":1185,"_21":1183},{"_23":1180,"_19":62,"_24":1181,"_26":-7,"_43":-7,"_64":1182,"_21":1180},{"_23":1177,"_19":62,"_24":1178,"_26":-7,"_43":-7,"_64":1179,"_21":1177},"api/applications/environments/seal-an-environment-into-a-versioned-image.mdx","Seal an environment into a versioned image POST","/docs/api/applications/environments/seal-an-environment-into-a-versioned-image","api/applications/environments/delete-an-environment.mdx","Delete an environment DELETE","/docs/api/applications/environments/delete-an-environment","api/applications/environments/update-an-environment.mdx","Update an environment (rename, tags, connector, agent config, run size) PUT","/docs/api/applications/environments/update-an-environment","api/applications/environments/get-an-environment.mdx","Get an environment GET","/docs/api/applications/environments/get-an-environment","api/applications/environments/create-an-environment.mdx","Create an environment POST","/docs/api/applications/environments/create-an-environment","api/applications/environments/list-environments.mdx","List environments GET","/docs/api/applications/environments/list-environments","api/applications/environments/index.mdx","6 operations.","/docs/api/applications/environments","Git deploys",[1203,1204,1205,1206,1207],"api/applications/git-deploys",{"_36":1200,"_45":1202},"api/applications/git-deploys/meta.json",{"_23":1220,"_19":62,"_24":1198,"_26":457,"_43":-7,"_64":1221,"_21":1220},{"_23":1217,"_19":62,"_24":1218,"_26":-7,"_43":-7,"_64":1219,"_21":1217},{"_23":1214,"_19":62,"_24":1215,"_26":-7,"_43":-7,"_64":1216,"_21":1214},{"_23":1211,"_19":62,"_24":1212,"_26":-7,"_43":-7,"_64":1213,"_21":1211},{"_23":1208,"_19":62,"_24":1209,"_26":-7,"_43":-7,"_64":1210,"_21":1208},"api/applications/git-deploys/dismiss-an-ai-build-start-suggestion.mdx","Dismiss an AI build/start suggestion DELETE","/docs/api/applications/git-deploys/dismiss-an-ai-build-start-suggestion","api/applications/git-deploys/poll-an-ai-build-start-suggestion.mdx","Poll an AI build/start suggestion GET","/docs/api/applications/git-deploys/poll-an-ai-build-start-suggestion","api/applications/git-deploys/ask-ai-for-build-start-commands.mdx","Ask AI for build/start commands POST","/docs/api/applications/git-deploys/ask-ai-for-build-start-commands","api/applications/git-deploys/deploy-an-app-from-a-git-repository.mdx","Deploy an app from a git repository POST","/docs/api/applications/git-deploys/deploy-an-app-from-a-git-repository","api/applications/git-deploys/index.mdx","/docs/api/applications/git-deploys","Deploy servers",[1227,1228,1229,1230,1231,1232,1233,1234,1235,1236,1237,1238,1239,1240,1241,1242,1243,1244,1245,1246,1247,1248,1249,1250,1251,1252,1253,1254,1255,1256,1257,1258,1259,1260,1261,1262,1263,1264,1265,1266,1267,1268,1269,1270,1271,1272,1273,1274,1275,1276,1277,1278,1279,1280,1281,1282,1283],"api/applications/deploy-servers",{"_36":1224,"_45":1226},"api/applications/deploy-servers/meta.json",{"_23":1452,"_19":62,"_24":1222,"_26":1453,"_43":-7,"_64":1454,"_21":1452},{"_23":1449,"_19":62,"_24":1450,"_26":-7,"_43":-7,"_64":1451,"_21":1449},{"_23":1446,"_19":62,"_24":1447,"_26":-7,"_43":-7,"_64":1448,"_21":1446},{"_23":1443,"_19":62,"_24":1444,"_26":-7,"_43":-7,"_64":1445,"_21":1443},{"_23":1440,"_19":62,"_24":1441,"_26":-7,"_43":-7,"_64":1442,"_21":1440},{"_23":1437,"_19":62,"_24":1438,"_26":-7,"_43":-7,"_64":1439,"_21":1437},{"_23":1434,"_19":62,"_24":1435,"_26":-7,"_43":-7,"_64":1436,"_21":1434},{"_23":1431,"_19":62,"_24":1432,"_26":-7,"_43":-7,"_64":1433,"_21":1431},{"_23":1428,"_19":62,"_24":1429,"_26":-7,"_43":-7,"_64":1430,"_21":1428},{"_23":1425,"_19":62,"_24":1426,"_26":-7,"_43":-7,"_64":1427,"_21":1425},{"_23":1422,"_19":62,"_24":1423,"_26":-7,"_43":-7,"_64":1424,"_21":1422},{"_23":1419,"_19":62,"_24":1420,"_26":-7,"_43":-7,"_64":1421,"_21":1419},{"_23":1416,"_19":62,"_24":1417,"_26":-7,"_43":-7,"_64":1418,"_21":1416},{"_23":1413,"_19":62,"_24":1414,"_26":-7,"_43":-7,"_64":1415,"_21":1413},{"_23":1410,"_19":62,"_24":1411,"_26":-7,"_43":-7,"_64":1412,"_21":1410},{"_23":1407,"_19":62,"_24":1408,"_26":-7,"_43":-7,"_64":1409,"_21":1407},{"_23":1404,"_19":62,"_24":1405,"_26":-7,"_43":-7,"_64":1406,"_21":1404},{"_23":1401,"_19":62,"_24":1402,"_26":-7,"_43":-7,"_64":1403,"_21":1401},{"_23":1398,"_19":62,"_24":1399,"_26":-7,"_43":-7,"_64":1400,"_21":1398},{"_23":1395,"_19":62,"_24":1396,"_26":-7,"_43":-7,"_64":1397,"_21":1395},{"_23":1392,"_19":62,"_24":1393,"_26":-7,"_43":-7,"_64":1394,"_21":1392},{"_23":1389,"_19":62,"_24":1390,"_26":-7,"_43":-7,"_64":1391,"_21":1389},{"_23":1386,"_19":62,"_24":1387,"_26":-7,"_43":-7,"_64":1388,"_21":1386},{"_23":1383,"_19":62,"_24":1384,"_26":-7,"_43":-7,"_64":1385,"_21":1383},{"_23":1380,"_19":62,"_24":1381,"_26":-7,"_43":-7,"_64":1382,"_21":1380},{"_23":1377,"_19":62,"_24":1378,"_26":-7,"_43":-7,"_64":1379,"_21":1377},{"_23":1374,"_19":62,"_24":1375,"_26":-7,"_43":-7,"_64":1376,"_21":1374},{"_23":1371,"_19":62,"_24":1372,"_26":-7,"_43":-7,"_64":1373,"_21":1371},{"_23":1368,"_19":62,"_24":1369,"_26":-7,"_43":-7,"_64":1370,"_21":1368},{"_23":1365,"_19":62,"_24":1366,"_26":-7,"_43":-7,"_64":1367,"_21":1365},{"_23":1362,"_19":62,"_24":1363,"_26":-7,"_43":-7,"_64":1364,"_21":1362},{"_23":1359,"_19":62,"_24":1360,"_26":-7,"_43":-7,"_64":1361,"_21":1359},{"_23":1356,"_19":62,"_24":1357,"_26":-7,"_43":-7,"_64":1358,"_21":1356},{"_23":1353,"_19":62,"_24":1354,"_26":-7,"_43":-7,"_64":1355,"_21":1353},{"_23":1350,"_19":62,"_24":1351,"_26":-7,"_43":-7,"_64":1352,"_21":1350},{"_23":1347,"_19":62,"_24":1348,"_26":-7,"_43":-7,"_64":1349,"_21":1347},{"_23":1344,"_19":62,"_24":1345,"_26":-7,"_43":-7,"_64":1346,"_21":1344},{"_23":1341,"_19":62,"_24":1342,"_26":-7,"_43":-7,"_64":1343,"_21":1341},{"_23":1338,"_19":62,"_24":1339,"_26":-7,"_43":-7,"_64":1340,"_21":1338},{"_23":1335,"_19":62,"_24":1336,"_26":-7,"_43":-7,"_64":1337,"_21":1335},{"_23":1332,"_19":62,"_24":1333,"_26":-7,"_43":-7,"_64":1334,"_21":1332},{"_23":1329,"_19":62,"_24":1330,"_26":-7,"_43":-7,"_64":1331,"_21":1329},{"_23":1326,"_19":62,"_24":1327,"_26":-7,"_43":-7,"_64":1328,"_21":1326},{"_23":1323,"_19":62,"_24":1324,"_26":-7,"_43":-7,"_64":1325,"_21":1323},{"_23":1320,"_19":62,"_24":1321,"_26":-7,"_43":-7,"_64":1322,"_21":1320},{"_23":1317,"_19":62,"_24":1318,"_26":-7,"_43":-7,"_64":1319,"_21":1317},{"_23":1314,"_19":62,"_24":1315,"_26":-7,"_43":-7,"_64":1316,"_21":1314},{"_23":1311,"_19":62,"_24":1312,"_26":-7,"_43":-7,"_64":1313,"_21":1311},{"_23":1308,"_19":62,"_24":1309,"_26":-7,"_43":-7,"_64":1310,"_21":1308},{"_23":1305,"_19":62,"_24":1306,"_26":-7,"_43":-7,"_64":1307,"_21":1305},{"_23":1302,"_19":62,"_24":1303,"_26":-7,"_43":-7,"_64":1304,"_21":1302},{"_23":1299,"_19":62,"_24":1300,"_26":-7,"_43":-7,"_64":1301,"_21":1299},{"_23":1296,"_19":62,"_24":1297,"_26":-7,"_43":-7,"_64":1298,"_21":1296},{"_23":1293,"_19":62,"_24":1294,"_26":-7,"_43":-7,"_64":1295,"_21":1293},{"_23":1290,"_19":62,"_24":1291,"_26":-7,"_43":-7,"_64":1292,"_21":1290},{"_23":1287,"_19":62,"_24":1288,"_26":-7,"_43":-7,"_64":1289,"_21":1287},{"_23":1284,"_19":62,"_24":1285,"_26":-7,"_43":-7,"_64":1286,"_21":1284},"api/applications/deploy-servers/remove-a-persistent-volume-from-a-service.mdx","Remove a persistent volume from a service DELETE","/docs/api/applications/deploy-servers/remove-a-persistent-volume-from-a-service","api/applications/deploy-servers/attach-a-persistent-volume-to-a-service-at-a.mdx","Attach a persistent volume to a service at a mount path (survives redeploys); restart to apply POST","/docs/api/applications/deploy-servers/attach-a-persistent-volume-to-a-service-at-a","api/applications/deploy-servers/list-a-service-s-persistent-storages.mdx","List a service's persistent storages (volumes) GET","/docs/api/applications/deploy-servers/list-a-service-s-persistent-storages","api/applications/deploy-servers/stop-a-running-service.mdx","Stop a running service POST","/docs/api/applications/deploy-servers/stop-a-running-service","api/applications/deploy-servers/start-a-stopped-service.mdx","Start a stopped service POST","/docs/api/applications/deploy-servers/start-a-stopped-service","api/applications/deploy-servers/delete-a-scheduled-task-from-a-service.mdx","Delete a scheduled task from a service DELETE","/docs/api/applications/deploy-servers/delete-a-scheduled-task-from-a-service","api/applications/deploy-servers/add-a-scheduled-cron-task-to-a-service.mdx","Add a scheduled cron task to a service (frequency is a cron expression) POST","/docs/api/applications/deploy-servers/add-a-scheduled-cron-task-to-a-service","api/applications/deploy-servers/list-a-service-s-scheduled.mdx","List a service's scheduled (cron) tasks GET","/docs/api/applications/deploy-servers/list-a-service-s-scheduled","api/applications/deploy-servers/restart-a-service.mdx","Restart a service POST","/docs/api/applications/deploy-servers/restart-a-service","api/applications/deploy-servers/delete-a-service-pass-delete-volumes-true-to.mdx","Delete a service. Pass ?delete_volumes=true to also destroy its data volumes. DELETE","/docs/api/applications/deploy-servers/delete-a-service-pass-delete-volumes-true-to","api/applications/deploy-servers/get-one-service.mdx","Get one service GET","/docs/api/applications/deploy-servers/get-one-service","api/applications/deploy-servers/create-a-service-provide-either-type.mdx","Create a service. Provide EITHER type (a Coolify one-click template name, e.g. plausible/n8n) OR docker_compose (a raw docker-compose.yml). Poll until status is 'running'. POST","/docs/api/applications/deploy-servers/create-a-service-provide-either-type","api/applications/deploy-servers/list-the-deploy-server-s-services.mdx","List the deploy server's services (uuid, name, type, status) GET","/docs/api/applications/deploy-servers/list-the-deploy-server-s-services","api/applications/deploy-servers/cancel-an-in-progress-deployment.mdx","Cancel an in-progress deployment POST","/docs/api/applications/deploy-servers/cancel-an-in-progress-deployment","api/applications/deploy-servers/get-a-deployment-s-status-log-tail.mdx","Get a deployment's status + log tail — read this when a deploy fails to see the real error GET","/docs/api/applications/deploy-servers/get-a-deployment-s-status-log-tail","api/applications/deploy-servers/list-the-deploy-server-s-in-progress-and-recent.mdx","List the deploy server's in-progress and recent deployments (deployment history: uuid, app, status, commit) GET","/docs/api/applications/deploy-servers/list-the-deploy-server-s-in-progress-and-recent","api/applications/deploy-servers/remove-a-persistent-volume-from-a-database.mdx","Remove a persistent volume from a database DELETE","/docs/api/applications/deploy-servers/remove-a-persistent-volume-from-a-database","api/applications/deploy-servers/attach-a-persistent-volume-to-a-database-at-a.mdx","Attach a persistent volume to a database at a mount path (survives redeploys); restart to apply POST","/docs/api/applications/deploy-servers/attach-a-persistent-volume-to-a-database-at-a","api/applications/deploy-servers/list-a-database-s-persistent-storages.mdx","List a database's persistent storages (volumes) GET","/docs/api/applications/deploy-servers/list-a-database-s-persistent-storages","api/applications/deploy-servers/stop-a-running-database.mdx","Stop a running database POST","/docs/api/applications/deploy-servers/stop-a-running-database","api/applications/deploy-servers/start-a-stopped-database.mdx","Start a stopped database POST","/docs/api/applications/deploy-servers/start-a-stopped-database","api/applications/deploy-servers/restart-a-database.mdx","Restart a database POST","/docs/api/applications/deploy-servers/restart-a-database","api/applications/deploy-servers/list-the-run-history-of-a-database-backup.mdx","List the run history of a database backup schedule (status, size, timestamp) GET","/docs/api/applications/deploy-servers/list-the-run-history-of-a-database-backup","api/applications/deploy-servers/delete-a-database-backup-schedule.mdx","Delete a database backup schedule DELETE","/docs/api/applications/deploy-servers/delete-a-database-backup-schedule","api/applications/deploy-servers/schedule-recurring-backups-for-a-database.mdx","Schedule recurring backups for a database (frequency is a cron expression, e.g. "0 2 * * *") POST","/docs/api/applications/deploy-servers/schedule-recurring-backups-for-a-database","api/applications/deploy-servers/list-a-database-s-scheduled-backups.mdx","List a database's scheduled backups GET","/docs/api/applications/deploy-servers/list-a-database-s-scheduled-backups","api/applications/deploy-servers/delete-a-database-pass-delete-volumes-true-to.mdx","Delete a database. Pass ?delete_volumes=true to also destroy its data volume. DELETE","/docs/api/applications/deploy-servers/delete-a-database-pass-delete-volumes-true-to","api/applications/deploy-servers/get-one-database.mdx","Get one database (poll until status is 'running') GET","/docs/api/applications/deploy-servers/get-one-database","api/applications/deploy-servers/create-a-managed-database-type-is-one-of.mdx","Create a managed database. type is one of postgresql|mysql|mariadb|mongodb|redis|keydb|dragonfly|clickhouse. Credentials are auto-generated — read the connection string from get_deploy_servers_id_databases_db. Poll until status is 'running'. POST","/docs/api/applications/deploy-servers/create-a-managed-database-type-is-one-of","api/applications/deploy-servers/list-the-deploy-server-s-databases.mdx","List the deploy server's databases (uuid, name, engine, status) GET","/docs/api/applications/deploy-servers/list-the-deploy-server-s-databases","api/applications/deploy-servers/get-a-deploy-server-s-dashboard-url-api-base.mdx","Get a deploy server's dashboard URL, API base URL, root credentials, API token, and worker id — read after status is ready GET","/docs/api/applications/deploy-servers/get-a-deploy-server-s-dashboard-url-api-base","api/applications/deploy-servers/get-an-artifact-push-s-status.mdx","Get an artifact push's status (staging|pushing|ready|failed; path is the worker directory when ready) GET","/docs/api/applications/deploy-servers/get-an-artifact-push-s-status","api/applications/deploy-servers/push-an-app-folder-tarball.mdx","Push an app folder tarball (.tgz) onto the deploy server's worker — lands extracted at /opt/apps/<name>. Source: team_object (a tarball a team member previously storage_put into team shared storage) or content_b64 for small archives. ASYNC: poll get_deploy_servers_id_artifacts until status=ready BEFORE building on the worker. POST","/docs/api/applications/deploy-servers/push-an-app-folder-tarball","api/applications/deploy-servers/remove-a-persistent-volume-from-an-application.mdx","Remove a persistent volume from an application DELETE","/docs/api/applications/deploy-servers/remove-a-persistent-volume-from-an-application","api/applications/deploy-servers/attach-a-persistent-volume-to-an-application-at.mdx","Attach a persistent volume to an application at a mount path so its data survives redeploys; redeploy to apply POST","/docs/api/applications/deploy-servers/attach-a-persistent-volume-to-an-application-at","api/applications/deploy-servers/list-an-application-s-persistent-storages.mdx","List an application's persistent storages (volumes) GET","/docs/api/applications/deploy-servers/list-an-application-s-persistent-storages","api/applications/deploy-servers/stop-an-application.mdx","Stop an application POST","/docs/api/applications/deploy-servers/stop-an-application","api/applications/deploy-servers/delete-a-scheduled-task-from-an-application.mdx","Delete a scheduled task from an application DELETE","/docs/api/applications/deploy-servers/delete-a-scheduled-task-from-an-application","api/applications/deploy-servers/add-a-scheduled-cron-task-to-an-application.mdx","Add a scheduled cron task to an application (frequency is a cron expression, command runs in the app container) POST","/docs/api/applications/deploy-servers/add-a-scheduled-cron-task-to-an-application","api/applications/deploy-servers/list-an-application-s-scheduled.mdx","List an application's scheduled (cron) tasks GET","/docs/api/applications/deploy-servers/list-an-application-s-scheduled","api/applications/deploy-servers/restart-an-application.mdx","Restart an application POST","/docs/api/applications/deploy-servers/restart-an-application","api/applications/deploy-servers/get-a-running-application-s-container-logs.mdx","Get a running application's container logs (RUNTIME logs — why the app is crashing/erroring at run time; distinct from the per-deployment build logs). Optional ?lines=N tail. GET","/docs/api/applications/deploy-servers/get-a-running-application-s-container-logs","api/applications/deploy-servers/delete-one-environment-variable-from-an.mdx","Delete one environment variable from an application by key; redeploy to apply DELETE","/docs/api/applications/deploy-servers/delete-one-environment-variable-from-an","api/applications/deploy-servers/set.mdx","Set (upsert) application environment variables; redeploy to apply POST","/docs/api/applications/deploy-servers/set","api/applications/deploy-servers/list-an-application-s-environment-variables.mdx","List an application's environment variables (values included) GET","/docs/api/applications/deploy-servers/list-an-application-s-environment-variables","api/applications/deploy-servers/deploy-an-application-with-tag-set-repoints-the.mdx","Deploy an application. With tag set, repoints the image tag first — ONE call both releases a new version (build+push vN, deploy with tag=vN) and rolls back (deploy with the previous tag). POST","/docs/api/applications/deploy-servers/deploy-an-application-with-tag-set-repoints-the","api/applications/deploy-servers/delete-an-application-from-the-deploy-server.mdx","Delete an application from the deploy server DELETE","/docs/api/applications/deploy-servers/delete-an-application-from-the-deploy-server","api/applications/deploy-servers/update-an-application-s-image-tag-port.mdx","Update an application's image/tag/port (then trigger a deploy to apply) PATCH","/docs/api/applications/deploy-servers/update-an-application-s-image-tag-port","api/applications/deploy-servers/get-one-application.mdx","Get one application — poll after create/deploy until status starts with 'running', then verify its public URL GET","/docs/api/applications/deploy-servers/get-one-application","api/applications/deploy-servers/create.mdx","Create (and by default instantly deploy) an application from a docker image in the worker's local registry. Push the app folder with create_deploy_servers_id_artifacts and docker build+push on the worker FIRST. Returns the app uuid and public URL — poll get_deploy_servers_id_applications until status starts with 'running'. POST","/docs/api/applications/deploy-servers/create","api/applications/deploy-servers/list-the-applications-deployed-on-the-deploy.mdx","List the applications deployed on the deploy server (uuid, status, public URL, image:tag) GET","/docs/api/applications/deploy-servers/list-the-applications-deployed-on-the-deploy","api/applications/deploy-servers/delete-a-deploy-server.mdx","Delete a deploy server (tears down the control plane + worker) DELETE","/docs/api/applications/deploy-servers/delete-a-deploy-server","api/applications/deploy-servers/scale-a-deploy-server-worker-count-adds-removes.mdx","Scale a deploy server: worker_count adds/removes deploy targets (1-10), worker_instance_type resizes every worker, worker_disk_gib grows their disks (grow-only), app_instance_type resizes the Coolify control plane. Workers change ONE at a time and the dashboard keeps serving; poll workers[] until every entry has registered=true. Resizing a worker RESTARTS it, briefly interrupting the apps on it. PUT","/docs/api/applications/deploy-servers/scale-a-deploy-server-worker-count-adds-removes","api/applications/deploy-servers/get-a-deploy-server.mdx","Get a deploy server (poll status until 'ready'; init_step shows provisioning progress) GET","/docs/api/applications/deploy-servers/get-a-deploy-server","api/applications/deploy-servers/create-the-tenant-s-deploy-server.mdx","Create the tenant's deploy server (Coolify) — idempotent: returns the existing one if present. This is the REQUIRED first step before deploying any app; it provisions the Coolify control plane + a worker automatically. POST","/docs/api/applications/deploy-servers/create-the-tenant-s-deploy-server","api/applications/deploy-servers/list-the-tenant-s-deploy-servers.mdx","List the tenant's deploy servers GET","/docs/api/applications/deploy-servers/list-the-tenant-s-deploy-servers","api/applications/deploy-servers/index.mdx","56 operations.","/docs/api/applications/deploy-servers",[1459,1460,1461,1462,1463,1464,1465,1466,1467,1468,1469,1470,1471,1472,1473,1474,1475,1476,1477,1478,1479,1480,1481,1482,1483,1484,1485,1486,1487,1488,1489,1490,1491,1492,1493,1494,1495,1496,1497,1498,1499],"api/applications/applications",{"_36":1456,"_45":1458},"api/applications/applications/meta.json",{"_23":1620,"_19":62,"_24":1003,"_26":1621,"_43":-7,"_64":1622,"_21":1620},{"_23":1617,"_19":62,"_24":1618,"_26":-7,"_43":-7,"_64":1619,"_21":1617},{"_23":1614,"_19":62,"_24":1615,"_26":-7,"_43":-7,"_64":1616,"_21":1614},{"_23":1611,"_19":62,"_24":1612,"_26":-7,"_43":-7,"_64":1613,"_21":1611},{"_23":1608,"_19":62,"_24":1609,"_26":-7,"_43":-7,"_64":1610,"_21":1608},{"_23":1605,"_19":62,"_24":1606,"_26":-7,"_43":-7,"_64":1607,"_21":1605},{"_23":1602,"_19":62,"_24":1603,"_26":-7,"_43":-7,"_64":1604,"_21":1602},{"_23":1599,"_19":62,"_24":1600,"_26":-7,"_43":-7,"_64":1601,"_21":1599},{"_23":1596,"_19":62,"_24":1597,"_26":-7,"_43":-7,"_64":1598,"_21":1596},{"_23":1593,"_19":62,"_24":1594,"_26":-7,"_43":-7,"_64":1595,"_21":1593},{"_23":1590,"_19":62,"_24":1591,"_26":-7,"_43":-7,"_64":1592,"_21":1590},{"_23":1587,"_19":62,"_24":1588,"_26":-7,"_43":-7,"_64":1589,"_21":1587},{"_23":1584,"_19":62,"_24":1585,"_26":-7,"_43":-7,"_64":1586,"_21":1584},{"_23":1581,"_19":62,"_24":1582,"_26":-7,"_43":-7,"_64":1583,"_21":1581},{"_23":1578,"_19":62,"_24":1579,"_26":-7,"_43":-7,"_64":1580,"_21":1578},{"_23":1575,"_19":62,"_24":1576,"_26":-7,"_43":-7,"_64":1577,"_21":1575},{"_23":1572,"_19":62,"_24":1573,"_26":-7,"_43":-7,"_64":1574,"_21":1572},{"_23":1569,"_19":62,"_24":1570,"_26":-7,"_43":-7,"_64":1571,"_21":1569},{"_23":1566,"_19":62,"_24":1567,"_26":-7,"_43":-7,"_64":1568,"_21":1566},{"_23":1563,"_19":62,"_24":1564,"_26":-7,"_43":-7,"_64":1565,"_21":1563},{"_23":1560,"_19":62,"_24":1561,"_26":-7,"_43":-7,"_64":1562,"_21":1560},{"_23":1557,"_19":62,"_24":1558,"_26":-7,"_43":-7,"_64":1559,"_21":1557},{"_23":1554,"_19":62,"_24":1555,"_26":-7,"_43":-7,"_64":1556,"_21":1554},{"_23":1551,"_19":62,"_24":1552,"_26":-7,"_43":-7,"_64":1553,"_21":1551},{"_23":1548,"_19":62,"_24":1549,"_26":-7,"_43":-7,"_64":1550,"_21":1548},{"_23":1545,"_19":62,"_24":1546,"_26":-7,"_43":-7,"_64":1547,"_21":1545},{"_23":1542,"_19":62,"_24":1543,"_26":-7,"_43":-7,"_64":1544,"_21":1542},{"_23":1539,"_19":62,"_24":1540,"_26":-7,"_43":-7,"_64":1541,"_21":1539},{"_23":1536,"_19":62,"_24":1537,"_26":-7,"_43":-7,"_64":1538,"_21":1536},{"_23":1533,"_19":62,"_24":1534,"_26":-7,"_43":-7,"_64":1535,"_21":1533},{"_23":1530,"_19":62,"_24":1531,"_26":-7,"_43":-7,"_64":1532,"_21":1530},{"_23":1527,"_19":62,"_24":1528,"_26":-7,"_43":-7,"_64":1529,"_21":1527},{"_23":1524,"_19":62,"_24":1525,"_26":-7,"_43":-7,"_64":1526,"_21":1524},{"_23":1521,"_19":62,"_24":1522,"_26":-7,"_43":-7,"_64":1523,"_21":1521},{"_23":1518,"_19":62,"_24":1519,"_26":-7,"_43":-7,"_64":1520,"_21":1518},{"_23":1515,"_19":62,"_24":1516,"_26":-7,"_43":-7,"_64":1517,"_21":1515},{"_23":1512,"_19":62,"_24":1513,"_26":-7,"_43":-7,"_64":1514,"_21":1512},{"_23":1509,"_19":62,"_24":1510,"_26":-7,"_43":-7,"_64":1511,"_21":1509},{"_23":1506,"_19":62,"_24":1507,"_26":-7,"_43":-7,"_64":1508,"_21":1506},{"_23":1503,"_19":62,"_24":1504,"_26":-7,"_43":-7,"_64":1505,"_21":1503},{"_23":1500,"_19":62,"_24":1501,"_26":-7,"_43":-7,"_64":1502,"_21":1500},"api/applications/applications/inspect-a-github-repository-and-propose-runtime.mdx","Inspect a GitHub repository and propose runtime, build and start commands and port before creating an application POST","/docs/api/applications/applications/inspect-a-github-repository-and-propose-runtime","api/applications/applications/ask-a-model-to-propose-build-and-start-commands.mdx","Ask a model to propose build and start commands and a deploy shape — from the repository, or from a description when there is no code yet POST","/docs/api/applications/applications/ask-a-model-to-propose-build-and-start-commands","api/applications/applications/replace-the-variables-of-one-scope.mdx","Replace the variables of one scope (app, env:<name> or svc:<name>); values are sealed and never returned PUT","/docs/api/applications/applications/replace-the-variables-of-one-scope","api/applications/applications/remove-a-repository-from-an-application.mdx","Remove a repository from an application (fails while a service is built from it) DELETE","/docs/api/applications/applications/remove-a-repository-from-an-application","api/applications/applications/add-or-replace-a-repository.mdx","Add or replace a repository (source) on an application POST","/docs/api/applications/applications/add-or-replace-a-repository","api/applications/applications/delete-a-service.mdx","Delete a service DELETE","/docs/api/applications/applications/delete-a-service","api/applications/applications/create-or-replace-a-service.mdx","Create or replace a service (built from a source, or a prebuilt image); the generated pipeline is updated automatically PUT","/docs/api/applications/applications/create-or-replace-a-service","api/applications/applications/reject-a-run-waiting-at-an-approval-gate-the.mdx","Reject a run waiting at an approval gate; the run ends canceled POST","/docs/api/applications/applications/reject-a-run-waiting-at-an-approval-gate-the","api/applications/applications/live-job-log.mdx","Live job log (SSE, text/event-stream) GET","/docs/api/applications/applications/live-job-log","api/applications/applications/read-a-job-s-stored-log-chunks-in-seq-order.mdx","Read a job's stored log chunks in seq order; poll with after=<seq> GET","/docs/api/applications/applications/read-a-job-s-stored-log-chunks-in-seq-order","api/applications/applications/list-a-run-s-jobs-in-stage-order.mdx","List a run's jobs in stage order (build/run jobs, their builder and outputs) GET","/docs/api/applications/applications/list-a-run-s-jobs-in-stage-order","api/applications/applications/cancel-a-run-in-flight-its-builders-are-reaped.mdx","Cancel a run in flight; its builders are reaped POST","/docs/api/applications/applications/cancel-a-run-in-flight-its-builders-are-reaped","api/applications/applications/approve-a-run-waiting-at-an-approval-gate-it.mdx","Approve a run waiting at an approval gate; it continues with the next stage POST","/docs/api/applications/applications/approve-a-run-waiting-at-an-approval-gate-it","api/applications/applications/get-one-run.mdx","Get one run (state queued|running|waiting_approval|succeeded|failed|canceled, current stage, resolved commits, release) GET","/docs/api/applications/applications/get-one-run","api/applications/applications/start-a-pipeline-run-builds-every-service-in-a.mdx","Start a pipeline run: builds every service in a throwaway builder microVM, produces a release, then walks the deploy stages. Body is optional — the default is a manual run on the first source's tracked branch. POST","/docs/api/applications/applications/start-a-pipeline-run-builds-every-service-in-a","api/applications/applications/list-an-application-s-runs-newest-first.mdx","List an application's runs newest-first GET","/docs/api/applications/applications/list-an-application-s-runs-newest-first","api/applications/applications/list-an-application-s-releases-newest-first.mdx","List an application's releases newest-first (each carries the per-service image refs a deploy pins) GET","/docs/api/applications/applications/list-an-application-s-releases-newest-first","api/applications/applications/replace-the-pipeline-spec.mdx","Replace the pipeline spec (stages of build/run jobs, deploy, approval; triggers). Send generated=true to return to the derived default. PUT","/docs/api/applications/applications/replace-the-pipeline-spec","api/applications/applications/get-the-pipeline-spec.mdx","Get the pipeline spec GET","/docs/api/applications/applications/get-the-pipeline-spec","api/applications/applications/promote-whatever-the-from-environment-is.mdx","Promote whatever the 'from' environment is running into this one (the release is resolved from the source environment's deployments) POST","/docs/api/applications/applications/promote-whatever-the-from-environment-is","api/applications/applications/drop-the-environment-s-load-balancer-so-the.mdx","Drop the environment's load balancer so the next deploy rebuilds its listener. Changes the environment's public address; this is how an environment moves from HTTP to HTTPS. DELETE","/docs/api/applications/applications/drop-the-environment-s-load-balancer-so-the","api/applications/applications/deploy-a-release-into-an-environment-omit.mdx","Deploy a release into an environment. Omit release_id for the newest release; name an older one to roll back. Starts a run so the pipeline's approval stages still apply. POST","/docs/api/applications/applications/deploy-a-release-into-an-environment-omit","api/applications/applications/delete-an-environment.mdx","Delete an environment (the last one cannot be deleted) DELETE","/docs/api/applications/applications/delete-an-environment","api/applications/applications/create-or-replace-an-environment.mdx","Create or replace an environment (branch/tag tracking, auto-deploy, approval, per-service overrides) PUT","/docs/api/applications/applications/create-or-replace-an-environment","api/applications/applications/request-changes-on-a-proposed-chat.mdx","Request changes on a proposed chat POST","/docs/api/applications/applications/request-changes-on-a-proposed-chat","api/applications/applications/ask-for-approval-opens-a-pull-request-from-the.mdx","Ask for approval: opens a pull request from the chat's branch into the tracked branch POST","/docs/api/applications/applications/ask-for-approval-opens-a-pull-request-from-the","api/applications/applications/the-agent-s-done-in-pull-request-mode-opens-the.mdx","The agent's "done": in pull-request mode opens the pull request for a human; in main mode merges the branch into the tracked branch with no pull request POST","/docs/api/applications/applications/the-agent-s-done-in-pull-request-mode-opens-the","api/applications/applications/run-ci-on-the-chat-s-branch-now-a-proposal-run.mdx","Run CI on the chat's branch now: a proposal run of its current head (builds and tests, deploys nothing) POST","/docs/api/applications/applications/run-ci-on-the-chat-s-branch-now-a-proposal-run","api/applications/applications/approve-a-proposed-chat-merges-its-pull-request.mdx","Approve a proposed chat: merges its pull request POST","/docs/api/applications/applications/approve-a-proposed-chat-merges-its-pull-request","api/applications/applications/start-a-developer-chat-on-an-application-an.mdx","Start a developer chat on an application: an agent team on its own branch POST","/docs/api/applications/applications/start-a-developer-chat-on-an-application-an","api/applications/applications/list-an-application-s-developer-chats-newest.mdx","List an application's developer chats newest-first (state working|proposed|rejected|merged) GET","/docs/api/applications/applications/list-an-application-s-developer-chats-newest","api/applications/applications/the-application-as-an-agent-must-know-it-before.mdx","The application as an agent must know it before touching the repository: services, build and start commands, port, databases, variable names and the interlaken.yaml. Every change request carries it; a session started by hand can be given it as its first message. GET","/docs/api/applications/applications/the-application-as-an-agent-must-know-it-before","api/applications/applications/dismiss-an-application-assist.mdx","Dismiss an application assist DELETE","/docs/api/applications/applications/dismiss-an-application-assist","api/applications/applications/poll-an-application-assist.mdx","Poll an application assist (state, live transcript, and the proposal once done) GET","/docs/api/applications/applications/poll-an-application-assist","api/applications/applications/ask-ai-to-propose-the-whole-application-from.mdx","Ask AI to propose the whole application from its repository POST","/docs/api/applications/applications/ask-ai-to-propose-the-whole-application-from","api/applications/applications/delete-an-application.mdx","Delete an application DELETE","/docs/api/applications/applications/delete-an-application","api/applications/applications/rename-an-application.mdx","Rename an application PATCH","/docs/api/applications/applications/rename-an-application","api/applications/applications/get-an-application-with-its-sources-services.mdx","Get an application with its sources, services, environments, pipeline and variable names GET","/docs/api/applications/applications/get-an-application-with-its-sources-services","api/applications/applications/create-an-application-from-a-git-repository.mdx","Create an application from a git repository. Simple path: repo_url + build_command/start_command/port. Advanced: sources, services, environments, pipeline. POST","/docs/api/applications/applications/create-an-application-from-a-git-repository","api/applications/applications/list-applications.mdx","List applications GET","/docs/api/applications/applications/list-applications","api/applications/applications/index.mdx","40 operations.","/docs/api/applications/applications","api/applications/index.mdx","/docs/api/applications","Kubernetes","Managed Kubernetes clusters and their node pools.",[1631,1632],"api/kubernetes",{"_36":1628,"_45":1630},"api/kubernetes/meta.json",{"_23":1677,"_19":62,"_24":1625,"_26":1626,"_43":-7,"_64":1678,"_21":1677},{"_19":36,"_24":1633,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1634,"_23":1635,"_21":1636,"_43":-7},"Kubernetes clusters",[1638,1639,1640,1641,1642,1643,1644,1645,1646,1647],"api/kubernetes/kubernetes-clusters",{"_36":1635,"_45":1637},"api/kubernetes/kubernetes-clusters/meta.json",{"_23":1675,"_19":62,"_24":1633,"_26":684,"_43":-7,"_64":1676,"_21":1675},{"_23":1672,"_19":62,"_24":1673,"_26":-7,"_43":-7,"_64":1674,"_21":1672},{"_23":1669,"_19":62,"_24":1670,"_26":-7,"_43":-7,"_64":1671,"_21":1669},{"_23":1666,"_19":62,"_24":1667,"_26":-7,"_43":-7,"_64":1668,"_21":1666},{"_23":1663,"_19":62,"_24":1664,"_26":-7,"_43":-7,"_64":1665,"_21":1663},{"_23":1660,"_19":62,"_24":1661,"_26":-7,"_43":-7,"_64":1662,"_21":1660},{"_23":1657,"_19":62,"_24":1658,"_26":-7,"_43":-7,"_64":1659,"_21":1657},{"_23":1654,"_19":62,"_24":1655,"_26":-7,"_43":-7,"_64":1656,"_21":1654},{"_23":1651,"_19":62,"_24":1652,"_26":-7,"_43":-7,"_64":1653,"_21":1651},{"_23":1648,"_19":62,"_24":1649,"_26":-7,"_43":-7,"_64":1650,"_21":1648},"api/kubernetes/kubernetes-clusters/list-installable-k3s-versions.mdx","List installable k3s versions GET","/docs/api/kubernetes/kubernetes-clusters/list-installable-k3s-versions","api/kubernetes/kubernetes-clusters/start-a-rolling-k3s-version-upgrade.mdx","Start a rolling k3s version upgrade POST","/docs/api/kubernetes/kubernetes-clusters/start-a-rolling-k3s-version-upgrade","api/kubernetes/kubernetes-clusters/list-a-cluster-s-nodes.mdx","List a cluster's nodes (control plane + workers) GET","/docs/api/kubernetes/kubernetes-clusters/list-a-cluster-s-nodes","api/kubernetes/kubernetes-clusters/download-the-cluster-s-admin-kubeconfig.mdx","Download the cluster's admin kubeconfig GET","/docs/api/kubernetes/kubernetes-clusters/download-the-cluster-s-admin-kubeconfig","api/kubernetes/kubernetes-clusters/delete-a-managed-kubernetes-cluster.mdx","Delete a managed Kubernetes cluster DELETE","/docs/api/kubernetes/kubernetes-clusters/delete-a-managed-kubernetes-cluster","api/kubernetes/kubernetes-clusters/update-a-managed-kubernetes-cluster.mdx","Update a managed Kubernetes cluster (rename, scale workers) PUT","/docs/api/kubernetes/kubernetes-clusters/update-a-managed-kubernetes-cluster","api/kubernetes/kubernetes-clusters/get-a-managed-kubernetes-cluster.mdx","Get a managed Kubernetes cluster GET","/docs/api/kubernetes/kubernetes-clusters/get-a-managed-kubernetes-cluster","api/kubernetes/kubernetes-clusters/create-a-managed-kubernetes.mdx","Create a managed Kubernetes (k3s) cluster POST","/docs/api/kubernetes/kubernetes-clusters/create-a-managed-kubernetes","api/kubernetes/kubernetes-clusters/list-managed-kubernetes-clusters.mdx","List managed Kubernetes clusters GET","/docs/api/kubernetes/kubernetes-clusters/list-managed-kubernetes-clusters","api/kubernetes/kubernetes-clusters/index.mdx","/docs/api/kubernetes/kubernetes-clusters","api/kubernetes/index.mdx","/docs/api/kubernetes","Networking","Tenant VPCs and everything attached to them: subnets, interfaces, addresses, load balancers, gateways and policy.",[1685,1686,1687,1688,1689,1690,1691,1692,1693,1694,1695,1696],"api/networking",{"_36":1682,"_45":1684},"api/networking/meta.json",{"_23":2088,"_19":62,"_24":1679,"_26":1680,"_43":-7,"_64":2089,"_21":2088},{"_19":36,"_24":2060,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2061,"_23":2062,"_21":2063,"_43":-7},{"_19":36,"_24":2024,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2025,"_23":2026,"_21":2027,"_43":-7},{"_19":36,"_24":1988,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1989,"_23":1990,"_21":1991,"_43":-7},{"_19":36,"_24":1951,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1952,"_23":1953,"_21":1954,"_43":-7},{"_19":36,"_24":1894,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1895,"_23":1896,"_21":1897,"_43":-7},{"_19":36,"_24":1866,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1867,"_23":1868,"_21":1869,"_43":-7},{"_19":36,"_24":1834,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1835,"_23":1836,"_21":1837,"_43":-7},{"_19":36,"_24":1806,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1807,"_23":1808,"_21":1809,"_43":-7},{"_19":36,"_24":1778,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1779,"_23":1780,"_21":1781,"_43":-7},{"_19":36,"_24":1750,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1751,"_23":1752,"_21":1753,"_43":-7},{"_19":36,"_24":1697,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":1698,"_23":1699,"_21":1700,"_43":-7},"Security policies",[1702,1703,1704,1705,1706,1707,1708,1709,1710,1711,1712,1713],"api/networking/security-policies",{"_36":1699,"_45":1701},"api/networking/security-policies/meta.json",{"_23":1747,"_19":62,"_24":1697,"_26":1748,"_43":-7,"_64":1749,"_21":1747},{"_23":1744,"_19":62,"_24":1745,"_26":-7,"_43":-7,"_64":1746,"_21":1744},{"_23":1741,"_19":62,"_24":1742,"_26":-7,"_43":-7,"_64":1743,"_21":1741},{"_23":1738,"_19":62,"_24":1739,"_26":-7,"_43":-7,"_64":1740,"_21":1738},{"_23":1735,"_19":62,"_24":1736,"_26":-7,"_43":-7,"_64":1737,"_21":1735},{"_23":1732,"_19":62,"_24":1733,"_26":-7,"_43":-7,"_64":1734,"_21":1732},{"_23":1729,"_19":62,"_24":1730,"_26":-7,"_43":-7,"_64":1731,"_21":1729},{"_23":1726,"_19":62,"_24":1727,"_26":-7,"_43":-7,"_64":1728,"_21":1726},{"_23":1723,"_19":62,"_24":1724,"_26":-7,"_43":-7,"_64":1725,"_21":1723},{"_23":1720,"_19":62,"_24":1721,"_26":-7,"_43":-7,"_64":1722,"_21":1720},{"_23":1717,"_19":62,"_24":1718,"_26":-7,"_43":-7,"_64":1719,"_21":1717},{"_23":1714,"_19":62,"_24":1715,"_26":-7,"_43":-7,"_64":1716,"_21":1714},"api/networking/security-policies/remove-a-security-policy-from-a-vpc.mdx","Remove a security policy from a VPC DELETE","/docs/api/networking/security-policies/remove-a-security-policy-from-a-vpc","api/networking/security-policies/apply-a-security-policy-to-every-nic-in-a-vpc.mdx","Apply a security policy to every NIC in a VPC POST","/docs/api/networking/security-policies/apply-a-security-policy-to-every-nic-in-a-vpc","api/networking/security-policies/remove-a-security-policy-from-a-subnet.mdx","Remove a security policy from a subnet DELETE","/docs/api/networking/security-policies/remove-a-security-policy-from-a-subnet","api/networking/security-policies/apply-a-security-policy-to-every-nic-in-a-subnet.mdx","Apply a security policy to every NIC in a subnet POST","/docs/api/networking/security-policies/apply-a-security-policy-to-every-nic-in-a-subnet","api/networking/security-policies/remove-a-security-policy-from-a-nic.mdx","Remove a security policy from a NIC DELETE","/docs/api/networking/security-policies/remove-a-security-policy-from-a-nic","api/networking/security-policies/apply-a-security-policy-to-a-nic.mdx","Apply a security policy to a NIC POST","/docs/api/networking/security-policies/apply-a-security-policy-to-a-nic","api/networking/security-policies/delete-a-security-policy.mdx","Delete a security policy DELETE","/docs/api/networking/security-policies/delete-a-security-policy","api/networking/security-policies/update-a-security-policy.mdx","Update a security policy PUT","/docs/api/networking/security-policies/update-a-security-policy","api/networking/security-policies/get-a-security-policy.mdx","Get a security policy GET","/docs/api/networking/security-policies/get-a-security-policy","api/networking/security-policies/create-a-security-policy.mdx","Create a security policy POST","/docs/api/networking/security-policies/create-a-security-policy","api/networking/security-policies/list-security-policies.mdx","List security policies GET","/docs/api/networking/security-policies/list-security-policies","api/networking/security-policies/index.mdx","11 operations.","/docs/api/networking/security-policies","Certificates",[1755,1756,1757,1758,1759,1760],"api/networking/certificates",{"_36":1752,"_45":1754},"api/networking/certificates/meta.json",{"_23":1776,"_19":62,"_24":1750,"_26":902,"_43":-7,"_64":1777,"_21":1776},{"_23":1773,"_19":62,"_24":1774,"_26":-7,"_43":-7,"_64":1775,"_21":1773},{"_23":1770,"_19":62,"_24":1771,"_26":-7,"_43":-7,"_64":1772,"_21":1770},{"_23":1767,"_19":62,"_24":1768,"_26":-7,"_43":-7,"_64":1769,"_21":1767},{"_23":1764,"_19":62,"_24":1765,"_26":-7,"_43":-7,"_64":1766,"_21":1764},{"_23":1761,"_19":62,"_24":1762,"_26":-7,"_43":-7,"_64":1763,"_21":1761},"api/networking/certificates/delete-a-certificate.mdx","Delete a certificate DELETE","/docs/api/networking/certificates/delete-a-certificate","api/networking/certificates/update-a-certificate.mdx","Update a certificate PUT","/docs/api/networking/certificates/update-a-certificate","api/networking/certificates/get-a-certificate.mdx","Get a certificate GET","/docs/api/networking/certificates/get-a-certificate","api/networking/certificates/create-a-certificate.mdx","Create a certificate POST","/docs/api/networking/certificates/create-a-certificate","api/networking/certificates/list-certificates.mdx","List certificates GET","/docs/api/networking/certificates/list-certificates","api/networking/certificates/index.mdx","/docs/api/networking/certificates","DHCP configs",[1783,1784,1785,1786,1787,1788],"api/networking/dhcp-configs",{"_36":1780,"_45":1782},"api/networking/dhcp-configs/meta.json",{"_23":1804,"_19":62,"_24":1778,"_26":902,"_43":-7,"_64":1805,"_21":1804},{"_23":1801,"_19":62,"_24":1802,"_26":-7,"_43":-7,"_64":1803,"_21":1801},{"_23":1798,"_19":62,"_24":1799,"_26":-7,"_43":-7,"_64":1800,"_21":1798},{"_23":1795,"_19":62,"_24":1796,"_26":-7,"_43":-7,"_64":1797,"_21":1795},{"_23":1792,"_19":62,"_24":1793,"_26":-7,"_43":-7,"_64":1794,"_21":1792},{"_23":1789,"_19":62,"_24":1790,"_26":-7,"_43":-7,"_64":1791,"_21":1789},"api/networking/dhcp-configs/delete-a-dhcp-config.mdx","Delete a DHCP config DELETE","/docs/api/networking/dhcp-configs/delete-a-dhcp-config","api/networking/dhcp-configs/update-a-dhcp-config.mdx","Update a DHCP config PUT","/docs/api/networking/dhcp-configs/update-a-dhcp-config","api/networking/dhcp-configs/get-a-dhcp-config.mdx","Get a DHCP config GET","/docs/api/networking/dhcp-configs/get-a-dhcp-config","api/networking/dhcp-configs/create-a-dhcp-config.mdx","Create a DHCP config POST","/docs/api/networking/dhcp-configs/create-a-dhcp-config","api/networking/dhcp-configs/list-dhcp-configs.mdx","List DHCP configs GET","/docs/api/networking/dhcp-configs/list-dhcp-configs","api/networking/dhcp-configs/index.mdx","/docs/api/networking/dhcp-configs","DNS records",[1811,1812,1813,1814,1815,1816],"api/networking/dns-records",{"_36":1808,"_45":1810},"api/networking/dns-records/meta.json",{"_23":1832,"_19":62,"_24":1806,"_26":902,"_43":-7,"_64":1833,"_21":1832},{"_23":1829,"_19":62,"_24":1830,"_26":-7,"_43":-7,"_64":1831,"_21":1829},{"_23":1826,"_19":62,"_24":1827,"_26":-7,"_43":-7,"_64":1828,"_21":1826},{"_23":1823,"_19":62,"_24":1824,"_26":-7,"_43":-7,"_64":1825,"_21":1823},{"_23":1820,"_19":62,"_24":1821,"_26":-7,"_43":-7,"_64":1822,"_21":1820},{"_23":1817,"_19":62,"_24":1818,"_26":-7,"_43":-7,"_64":1819,"_21":1817},"api/networking/dns-records/delete-a-dns-record.mdx","Delete a DNS record DELETE","/docs/api/networking/dns-records/delete-a-dns-record","api/networking/dns-records/update-a-dns-record.mdx","Update a DNS record PUT","/docs/api/networking/dns-records/update-a-dns-record","api/networking/dns-records/get-a-dns-record.mdx","Get a DNS record GET","/docs/api/networking/dns-records/get-a-dns-record","api/networking/dns-records/create-a-dns-record.mdx","Create a DNS record POST","/docs/api/networking/dns-records/create-a-dns-record","api/networking/dns-records/list-dns-records.mdx","List DNS records GET","/docs/api/networking/dns-records/list-dns-records","api/networking/dns-records/index.mdx","/docs/api/networking/dns-records","Vpn gateways",[1839,1840,1841,1842,1843,1844,1845],"api/networking/vpn-gateways",{"_36":1836,"_45":1838},"api/networking/vpn-gateways/meta.json",{"_23":1864,"_19":62,"_24":1834,"_26":1196,"_43":-7,"_64":1865,"_21":1864},{"_23":1861,"_19":62,"_24":1862,"_26":-7,"_43":-7,"_64":1863,"_21":1861},{"_23":1858,"_19":62,"_24":1859,"_26":-7,"_43":-7,"_64":1860,"_21":1858},{"_23":1855,"_19":62,"_24":1856,"_26":-7,"_43":-7,"_64":1857,"_21":1855},{"_23":1852,"_19":62,"_24":1853,"_26":-7,"_43":-7,"_64":1854,"_21":1852},{"_23":1849,"_19":62,"_24":1850,"_26":-7,"_43":-7,"_64":1851,"_21":1849},{"_23":1846,"_19":62,"_24":1847,"_26":-7,"_43":-7,"_64":1848,"_21":1846},"api/networking/vpn-gateways/download-the-vpn-client-profile.mdx","Download the VPN client profile GET","/docs/api/networking/vpn-gateways/download-the-vpn-client-profile","api/networking/vpn-gateways/delete-a-vpn-gateway.mdx","Delete a VPN gateway DELETE","/docs/api/networking/vpn-gateways/delete-a-vpn-gateway","api/networking/vpn-gateways/update-a-vpn-gateway.mdx","Update a VPN gateway PUT","/docs/api/networking/vpn-gateways/update-a-vpn-gateway","api/networking/vpn-gateways/get-a-vpn-gateway.mdx","Get a VPN gateway GET","/docs/api/networking/vpn-gateways/get-a-vpn-gateway","api/networking/vpn-gateways/create-a-vpn-gateway.mdx","Create a VPN gateway POST","/docs/api/networking/vpn-gateways/create-a-vpn-gateway","api/networking/vpn-gateways/list-vpn-gateways.mdx","List VPN gateways GET","/docs/api/networking/vpn-gateways/list-vpn-gateways","api/networking/vpn-gateways/index.mdx","/docs/api/networking/vpn-gateways","Gateways",[1871,1872,1873,1874,1875,1876],"api/networking/gateways",{"_36":1868,"_45":1870},"api/networking/gateways/meta.json",{"_23":1892,"_19":62,"_24":1866,"_26":902,"_43":-7,"_64":1893,"_21":1892},{"_23":1889,"_19":62,"_24":1890,"_26":-7,"_43":-7,"_64":1891,"_21":1889},{"_23":1886,"_19":62,"_24":1887,"_26":-7,"_43":-7,"_64":1888,"_21":1886},{"_23":1883,"_19":62,"_24":1884,"_26":-7,"_43":-7,"_64":1885,"_21":1883},{"_23":1880,"_19":62,"_24":1881,"_26":-7,"_43":-7,"_64":1882,"_21":1880},{"_23":1877,"_19":62,"_24":1878,"_26":-7,"_43":-7,"_64":1879,"_21":1877},"api/networking/gateways/delete-a-gateway.mdx","Delete a gateway DELETE","/docs/api/networking/gateways/delete-a-gateway","api/networking/gateways/update-a-gateway.mdx","Update a gateway PUT","/docs/api/networking/gateways/update-a-gateway","api/networking/gateways/get-a-gateway.mdx","Get a gateway GET","/docs/api/networking/gateways/get-a-gateway","api/networking/gateways/create-a-gateway.mdx","Create a gateway POST","/docs/api/networking/gateways/create-a-gateway","api/networking/gateways/list-gateways.mdx","List gateways GET","/docs/api/networking/gateways/list-gateways","api/networking/gateways/index.mdx","/docs/api/networking/gateways","Load balancers",[1899,1900,1901,1902,1903,1904,1905,1906,1907,1908,1909,1910,1911],"api/networking/load-balancers",{"_36":1896,"_45":1898},"api/networking/load-balancers/meta.json",{"_23":1948,"_19":62,"_24":1894,"_26":1949,"_43":-7,"_64":1950,"_21":1948},{"_23":1945,"_19":62,"_24":1946,"_26":-7,"_43":-7,"_64":1947,"_21":1945},{"_23":1942,"_19":62,"_24":1943,"_26":-7,"_43":-7,"_64":1944,"_21":1942},{"_23":1939,"_19":62,"_24":1940,"_26":-7,"_43":-7,"_64":1941,"_21":1939},{"_23":1936,"_19":62,"_24":1937,"_26":-7,"_43":-7,"_64":1938,"_21":1936},{"_23":1933,"_19":62,"_24":1934,"_26":-7,"_43":-7,"_64":1935,"_21":1933},{"_23":1930,"_19":62,"_24":1931,"_26":-7,"_43":-7,"_64":1932,"_21":1930},{"_23":1927,"_19":62,"_24":1928,"_26":-7,"_43":-7,"_64":1929,"_21":1927},{"_23":1924,"_19":62,"_24":1925,"_26":-7,"_43":-7,"_64":1926,"_21":1924},{"_23":1921,"_19":62,"_24":1922,"_26":-7,"_43":-7,"_64":1923,"_21":1921},{"_23":1918,"_19":62,"_24":1919,"_26":-7,"_43":-7,"_64":1920,"_21":1918},{"_23":1915,"_19":62,"_24":1916,"_26":-7,"_43":-7,"_64":1917,"_21":1915},{"_23":1912,"_19":62,"_24":1913,"_26":-7,"_43":-7,"_64":1914,"_21":1912},"api/networking/load-balancers/set-a-target-s-weight.mdx","Set a target's weight PUT","/docs/api/networking/load-balancers/set-a-target-s-weight","api/networking/load-balancers/remove-a-target-from-a-load-balancer.mdx","Remove a target from a load balancer DELETE","/docs/api/networking/load-balancers/remove-a-target-from-a-load-balancer","api/networking/load-balancers/add-a-target-to-a-load-balancer.mdx","Add a target to a load balancer POST","/docs/api/networking/load-balancers/add-a-target-to-a-load-balancer","api/networking/load-balancers/delete-an-lb-route.mdx","Delete an LB route DELETE","/docs/api/networking/load-balancers/delete-an-lb-route","api/networking/load-balancers/update-an-lb-route.mdx","Update an LB route PUT","/docs/api/networking/load-balancers/update-an-lb-route","api/networking/load-balancers/create-an-lb-route.mdx","Create an LB route POST","/docs/api/networking/load-balancers/create-an-lb-route","api/networking/load-balancers/list-lb-routes.mdx","List LB routes GET","/docs/api/networking/load-balancers/list-lb-routes","api/networking/load-balancers/delete-a-load-balancer.mdx","Delete a load balancer DELETE","/docs/api/networking/load-balancers/delete-a-load-balancer","api/networking/load-balancers/update-a-load-balancer.mdx","Update a load balancer PUT","/docs/api/networking/load-balancers/update-a-load-balancer","api/networking/load-balancers/get-a-load-balancer.mdx","Get a load balancer GET","/docs/api/networking/load-balancers/get-a-load-balancer","api/networking/load-balancers/create-a-load-balancer.mdx","Create a load balancer POST","/docs/api/networking/load-balancers/create-a-load-balancer","api/networking/load-balancers/list-load-balancers.mdx","List load balancers GET","/docs/api/networking/load-balancers/list-load-balancers","api/networking/load-balancers/index.mdx","12 operations.","/docs/api/networking/load-balancers","Public IPs",[1956,1957,1958,1959,1960,1961,1962,1963],"api/networking/public-ips",{"_36":1953,"_45":1955},"api/networking/public-ips/meta.json",{"_23":1985,"_19":62,"_24":1951,"_26":1986,"_43":-7,"_64":1987,"_21":1985},{"_23":1982,"_19":62,"_24":1983,"_26":-7,"_43":-7,"_64":1984,"_21":1982},{"_23":1979,"_19":62,"_24":1980,"_26":-7,"_43":-7,"_64":1981,"_21":1979},{"_23":1976,"_19":62,"_24":1977,"_26":-7,"_43":-7,"_64":1978,"_21":1976},{"_23":1973,"_19":62,"_24":1974,"_26":-7,"_43":-7,"_64":1975,"_21":1973},{"_23":1970,"_19":62,"_24":1971,"_26":-7,"_43":-7,"_64":1972,"_21":1970},{"_23":1967,"_19":62,"_24":1968,"_26":-7,"_43":-7,"_64":1969,"_21":1967},{"_23":1964,"_19":62,"_24":1965,"_26":-7,"_43":-7,"_64":1966,"_21":1964},"api/networking/public-ips/detach-a-public-ip-from-a-nic.mdx","Detach a public IP from a NIC POST","/docs/api/networking/public-ips/detach-a-public-ip-from-a-nic","api/networking/public-ips/attach-a-public-ip-to-a-nic.mdx","Attach a public IP to a NIC POST","/docs/api/networking/public-ips/attach-a-public-ip-to-a-nic","api/networking/public-ips/delete-a-public-ip.mdx","Delete a public IP DELETE","/docs/api/networking/public-ips/delete-a-public-ip","api/networking/public-ips/update-a-public-ip.mdx","Update a public IP PUT","/docs/api/networking/public-ips/update-a-public-ip","api/networking/public-ips/get-a-public-ip.mdx","Get a public IP GET","/docs/api/networking/public-ips/get-a-public-ip","api/networking/public-ips/create-a-public-ip.mdx","Create a public IP POST","/docs/api/networking/public-ips/create-a-public-ip","api/networking/public-ips/list-public-ips.mdx","List public IPs GET","/docs/api/networking/public-ips/list-public-ips","api/networking/public-ips/index.mdx","7 operations.","/docs/api/networking/public-ips","Network interfaces",[1993,1994,1995,1996,1997,1998,1999,2000],"api/networking/nics",{"_36":1990,"_45":1992},"api/networking/nics/meta.json",{"_23":2022,"_19":62,"_24":1988,"_26":1986,"_43":-7,"_64":2023,"_21":2022},{"_23":2019,"_19":62,"_24":2020,"_26":-7,"_43":-7,"_64":2021,"_21":2019},{"_23":2016,"_19":62,"_24":2017,"_26":-7,"_43":-7,"_64":2018,"_21":2016},{"_23":2013,"_19":62,"_24":2014,"_26":-7,"_43":-7,"_64":2015,"_21":2013},{"_23":2010,"_19":62,"_24":2011,"_26":-7,"_43":-7,"_64":2012,"_21":2010},{"_23":2007,"_19":62,"_24":2008,"_26":-7,"_43":-7,"_64":2009,"_21":2007},{"_23":2004,"_19":62,"_24":2005,"_26":-7,"_43":-7,"_64":2006,"_21":2004},{"_23":2001,"_19":62,"_24":2002,"_26":-7,"_43":-7,"_64":2003,"_21":2001},"api/networking/nics/reap-orphaned-pod-nics.mdx","Reap orphaned pod NICs (CNI liveness sweep) POST","/docs/api/networking/nics/reap-orphaned-pod-nics","api/networking/nics/attach-a-nic-to-a-workload.mdx","Attach a NIC to a workload POST","/docs/api/networking/nics/attach-a-nic-to-a-workload","api/networking/nics/delete-a-nic.mdx","Delete a NIC DELETE","/docs/api/networking/nics/delete-a-nic","api/networking/nics/update-a-nic.mdx","Update a NIC PUT","/docs/api/networking/nics/update-a-nic","api/networking/nics/get-a-nic.mdx","Get a NIC GET","/docs/api/networking/nics/get-a-nic","api/networking/nics/create-a-nic.mdx","Create a NIC POST","/docs/api/networking/nics/create-a-nic","api/networking/nics/list-nics.mdx","List NICs GET","/docs/api/networking/nics/list-nics","api/networking/nics/index.mdx","/docs/api/networking/nics","Subnets",[2029,2030,2031,2032,2033,2034,2035,2036],"api/networking/subnets",{"_36":2026,"_45":2028},"api/networking/subnets/meta.json",{"_23":2058,"_19":62,"_24":2024,"_26":1986,"_43":-7,"_64":2059,"_21":2058},{"_23":2055,"_19":62,"_24":2056,"_26":-7,"_43":-7,"_64":2057,"_21":2055},{"_23":2052,"_19":62,"_24":2053,"_26":-7,"_43":-7,"_64":2054,"_21":2052},{"_23":2049,"_19":62,"_24":2050,"_26":-7,"_43":-7,"_64":2051,"_21":2049},{"_23":2046,"_19":62,"_24":2047,"_26":-7,"_43":-7,"_64":2048,"_21":2046},{"_23":2043,"_19":62,"_24":2044,"_26":-7,"_43":-7,"_64":2045,"_21":2043},{"_23":2040,"_19":62,"_24":2041,"_26":-7,"_43":-7,"_64":2042,"_21":2040},{"_23":2037,"_19":62,"_24":2038,"_26":-7,"_43":-7,"_64":2039,"_21":2037},"api/networking/subnets/detach-the-dhcp-config-from-a-subnet.mdx","Detach the DHCP config from a subnet DELETE","/docs/api/networking/subnets/detach-the-dhcp-config-from-a-subnet","api/networking/subnets/attach-a-dhcp-config-to-a-subnet.mdx","Attach a DHCP config to a subnet POST","/docs/api/networking/subnets/attach-a-dhcp-config-to-a-subnet","api/networking/subnets/delete-a-subnet.mdx","Delete a subnet DELETE","/docs/api/networking/subnets/delete-a-subnet","api/networking/subnets/update-a-subnet.mdx","Update a subnet PUT","/docs/api/networking/subnets/update-a-subnet","api/networking/subnets/get-a-subnet.mdx","Get a subnet GET","/docs/api/networking/subnets/get-a-subnet","api/networking/subnets/create-a-subnet.mdx","Create a subnet POST","/docs/api/networking/subnets/create-a-subnet","api/networking/subnets/list-subnets.mdx","List subnets GET","/docs/api/networking/subnets/list-subnets","api/networking/subnets/index.mdx","/docs/api/networking/subnets","VPCs",[2065,2066,2067,2068,2069,2070],"api/networking/vpcs",{"_36":2062,"_45":2064},"api/networking/vpcs/meta.json",{"_23":2086,"_19":62,"_24":2060,"_26":902,"_43":-7,"_64":2087,"_21":2086},{"_23":2083,"_19":62,"_24":2084,"_26":-7,"_43":-7,"_64":2085,"_21":2083},{"_23":2080,"_19":62,"_24":2081,"_26":-7,"_43":-7,"_64":2082,"_21":2080},{"_23":2077,"_19":62,"_24":2078,"_26":-7,"_43":-7,"_64":2079,"_21":2077},{"_23":2074,"_19":62,"_24":2075,"_26":-7,"_43":-7,"_64":2076,"_21":2074},{"_23":2071,"_19":62,"_24":2072,"_26":-7,"_43":-7,"_64":2073,"_21":2071},"api/networking/vpcs/delete-a-vpc.mdx","Delete a VPC DELETE","/docs/api/networking/vpcs/delete-a-vpc","api/networking/vpcs/update-a-vpc.mdx","Update a VPC PUT","/docs/api/networking/vpcs/update-a-vpc","api/networking/vpcs/get-a-vpc.mdx","Get a VPC GET","/docs/api/networking/vpcs/get-a-vpc","api/networking/vpcs/create-a-vpc.mdx","Create a VPC POST","/docs/api/networking/vpcs/create-a-vpc","api/networking/vpcs/list-vpcs.mdx","List VPCs GET","/docs/api/networking/vpcs/list-vpcs","api/networking/vpcs/index.mdx","/docs/api/networking/vpcs","api/networking/index.mdx","/docs/api/networking","Storage","Block devices, their snapshots, object storage buckets and backup repositories.",[2096,2097,2098,2099],"api/storage",{"_36":2093,"_45":2095},"api/storage/meta.json",{"_23":2233,"_19":62,"_24":2090,"_26":2091,"_43":-7,"_64":2234,"_21":2233},{"_19":36,"_24":2161,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2162,"_23":2163,"_21":2164,"_43":-7},{"_19":36,"_24":2112,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2113,"_23":2114,"_21":2115,"_43":-7},{"_19":36,"_24":2100,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2101,"_23":2102,"_21":2103,"_43":-7},"IOPS tiers",[2105,2106],"api/storage/storage-iops-tiers",{"_36":2102,"_45":2104},"api/storage/storage-iops-tiers/meta.json",{"_23":2110,"_19":62,"_24":2100,"_26":68,"_43":-7,"_64":2111,"_21":2110},{"_23":2107,"_19":62,"_24":2108,"_26":-7,"_43":-7,"_64":2109,"_21":2107},"api/storage/storage-iops-tiers/list-storage-iops-tiers.mdx","List storage IOPS tiers GET","/docs/api/storage/storage-iops-tiers/list-storage-iops-tiers","api/storage/storage-iops-tiers/index.mdx","/docs/api/storage/storage-iops-tiers","Buckets",[2117,2118,2119,2120,2121,2122,2123,2124,2125,2126,2127],"api/storage/buckets",{"_36":2114,"_45":2116},"api/storage/buckets/meta.json",{"_23":2158,"_19":62,"_24":2112,"_26":2159,"_43":-7,"_64":2160,"_21":2158},{"_23":2155,"_19":62,"_24":2156,"_26":-7,"_43":-7,"_64":2157,"_21":2155},{"_23":2152,"_19":62,"_24":2153,"_26":-7,"_43":-7,"_64":2154,"_21":2152},{"_23":2149,"_19":62,"_24":2150,"_26":-7,"_43":-7,"_64":2151,"_21":2149},{"_23":2146,"_19":62,"_24":2147,"_26":-7,"_43":-7,"_64":2148,"_21":2146},{"_23":2143,"_19":62,"_24":2144,"_26":-7,"_43":-7,"_64":2145,"_21":2143},{"_23":2140,"_19":62,"_24":2141,"_26":-7,"_43":-7,"_64":2142,"_21":2140},{"_23":2137,"_19":62,"_24":2138,"_26":-7,"_43":-7,"_64":2139,"_21":2137},{"_23":2134,"_19":62,"_24":2135,"_26":-7,"_43":-7,"_64":2136,"_21":2134},{"_23":2131,"_19":62,"_24":2132,"_26":-7,"_43":-7,"_64":2133,"_21":2131},{"_23":2128,"_19":62,"_24":2129,"_26":-7,"_43":-7,"_64":2130,"_21":2128},"api/storage/buckets/get-a-bucket-s-scoped-access-secret-keys.mdx","Get a bucket's scoped access + secret keys GET","/docs/api/storage/buckets/get-a-bucket-s-scoped-access-secret-keys","api/storage/buckets/download-an-object.mdx","Download an object GET","/docs/api/storage/buckets/download-an-object","api/storage/buckets/delete-a-single-object.mdx","Delete a single object DELETE","/docs/api/storage/buckets/delete-a-single-object","api/storage/buckets/upload-an-object.mdx","Upload an object (multipart/form-data: file, key, prefix) POST","/docs/api/storage/buckets/upload-an-object","api/storage/buckets/list-objects-in-a-bucket.mdx","List objects in a bucket GET","/docs/api/storage/buckets/list-objects-in-a-bucket","api/storage/buckets/delete-a-bucket.mdx","Delete a bucket (409 if not empty) DELETE","/docs/api/storage/buckets/delete-a-bucket","api/storage/buckets/update-a-bucket.mdx","Update a bucket PUT","/docs/api/storage/buckets/update-a-bucket","api/storage/buckets/get-a-bucket.mdx","Get a bucket GET","/docs/api/storage/buckets/get-a-bucket","api/storage/buckets/create-a-bucket.mdx","Create a bucket POST","/docs/api/storage/buckets/create-a-bucket","api/storage/buckets/list-buckets.mdx","List buckets GET","/docs/api/storage/buckets/list-buckets","api/storage/buckets/index.mdx","10 operations.","/docs/api/storage/buckets","Disks",[2166,2167,2168,2169,2170,2171,2172,2173,2174,2175,2176,2177,2178,2179,2180,2181,2182],"api/storage/disks",{"_36":2163,"_45":2165},"api/storage/disks/meta.json",{"_23":2231,"_19":62,"_24":2161,"_26":975,"_43":-7,"_64":2232,"_21":2231},{"_23":2228,"_19":62,"_24":2229,"_26":-7,"_43":-7,"_64":2230,"_21":2228},{"_23":2225,"_19":62,"_24":2226,"_26":-7,"_43":-7,"_64":2227,"_21":2225},{"_23":2222,"_19":62,"_24":2223,"_26":-7,"_43":-7,"_64":2224,"_21":2222},{"_23":2219,"_19":62,"_24":2220,"_26":-7,"_43":-7,"_64":2221,"_21":2219},{"_23":2216,"_19":62,"_24":2217,"_26":-7,"_43":-7,"_64":2218,"_21":2216},{"_23":2213,"_19":62,"_24":2214,"_26":-7,"_43":-7,"_64":2215,"_21":2213},{"_23":2210,"_19":62,"_24":2211,"_26":-7,"_43":-7,"_64":2212,"_21":2210},{"_23":2207,"_19":62,"_24":2208,"_26":-7,"_43":-7,"_64":2209,"_21":2207},{"_23":2204,"_19":62,"_24":2205,"_26":-7,"_43":-7,"_64":2206,"_21":2204},{"_23":2201,"_19":62,"_24":2202,"_26":-7,"_43":-7,"_64":2203,"_21":2201},{"_23":2198,"_19":62,"_24":2199,"_26":-7,"_43":-7,"_64":2200,"_21":2198},{"_23":2195,"_19":62,"_24":2196,"_26":-7,"_43":-7,"_64":2197,"_21":2195},{"_23":2192,"_19":62,"_24":2193,"_26":-7,"_43":-7,"_64":2194,"_21":2192},{"_23":2189,"_19":62,"_24":2190,"_26":-7,"_43":-7,"_64":2191,"_21":2189},{"_23":2186,"_19":62,"_24":2187,"_26":-7,"_43":-7,"_64":2188,"_21":2186},{"_23":2183,"_19":62,"_24":2184,"_26":-7,"_43":-7,"_64":2185,"_21":2183},"api/storage/disks/adopt-an-orphaned-linstor-volume-into-a-disk-row.mdx","Adopt an orphaned LINSTOR volume into a disk row (admin) POST","/docs/api/storage/disks/adopt-an-orphaned-linstor-volume-into-a-disk-row","api/storage/disks/roll-a-disk-back-to-a-snapshot-in-place.mdx","Roll a disk back to a snapshot in place POST","/docs/api/storage/disks/roll-a-disk-back-to-a-snapshot-in-place","api/storage/disks/restore-a-disk-snapshot-into-a-new-resource.mdx","Restore a disk snapshot into a new resource POST","/docs/api/storage/disks/restore-a-disk-snapshot-into-a-new-resource","api/storage/disks/delete-a-disk-snapshot.mdx","Delete a disk snapshot DELETE","/docs/api/storage/disks/delete-a-disk-snapshot","api/storage/disks/create-a-disk-snapshot.mdx","Create a disk snapshot POST","/docs/api/storage/disks/create-a-disk-snapshot","api/storage/disks/list-disk-snapshots.mdx","List disk snapshots GET","/docs/api/storage/disks/list-disk-snapshots","api/storage/disks/migrate-a-disk-to-another-host.mdx","Migrate a disk to another host (LINSTOR-replicated) POST","/docs/api/storage/disks/migrate-a-disk-to-another-host","api/storage/disks/release-a-host-s-access-to-the-disk.mdx","Release a host's access to the disk DELETE","/docs/api/storage/disks/release-a-host-s-access-to-the-disk","api/storage/disks/ensure-a-host-can-access-the-disk.mdx","Ensure a host can access the disk (adds a diskless replica when needed) POST","/docs/api/storage/disks/ensure-a-host-can-access-the-disk","api/storage/disks/detach-a-disk-from-a-vm.mdx","Detach a disk from a VM POST","/docs/api/storage/disks/detach-a-disk-from-a-vm","api/storage/disks/attach-a-disk-to-a-vm.mdx","Attach a disk to a VM POST","/docs/api/storage/disks/attach-a-disk-to-a-vm","api/storage/disks/delete-a-disk.mdx","Delete a disk DELETE","/docs/api/storage/disks/delete-a-disk","api/storage/disks/update-a-disk.mdx","Update a disk PUT","/docs/api/storage/disks/update-a-disk","api/storage/disks/get-a-disk.mdx","Get a disk GET","/docs/api/storage/disks/get-a-disk","api/storage/disks/create-a-disk.mdx","Create a disk POST","/docs/api/storage/disks/create-a-disk","api/storage/disks/list-disks.mdx","List disks GET","/docs/api/storage/disks/list-disks","api/storage/disks/index.mdx","/docs/api/storage/disks","api/storage/index.mdx","/docs/api/storage","Compute","Virtual machines, microVMs and containers, together with the images, instance types and keys they are built from.",[2241,2242,2243,2244,2245,2246,2247,2248,2249,2250,2251],"api/compute",{"_36":2238,"_45":2240},"api/compute/meta.json",{"_23":2721,"_19":62,"_24":2235,"_26":2236,"_43":-7,"_64":2722,"_21":2721},{"_19":36,"_24":2601,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2602,"_23":2603,"_21":2604,"_43":-7},{"_19":36,"_24":2501,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2502,"_23":2503,"_21":2504,"_43":-7},{"_19":36,"_24":2404,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2405,"_23":2406,"_21":2407,"_43":-7},{"_19":36,"_24":2388,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2389,"_23":2390,"_21":2391,"_43":-7},{"_19":36,"_24":2376,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2377,"_23":2378,"_21":2379,"_43":-7},{"_19":36,"_24":2348,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2349,"_23":2350,"_21":2351,"_43":-7},{"_19":36,"_24":2316,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2317,"_23":2318,"_21":2319,"_43":-7},{"_19":36,"_24":2288,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2289,"_23":2290,"_21":2291,"_43":-7},{"_19":36,"_24":2268,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2269,"_23":2270,"_21":2271,"_43":-7},{"_19":36,"_24":2252,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2253,"_23":2254,"_21":2255,"_43":-7},"Scheduler",[2257,2258,2259],"api/compute/scheduler",{"_36":2254,"_45":2256},"api/compute/scheduler/meta.json",{"_23":2266,"_19":62,"_24":2252,"_26":1055,"_43":-7,"_64":2267,"_21":2266},{"_23":2263,"_19":62,"_24":2264,"_26":-7,"_43":-7,"_64":2265,"_21":2263},{"_23":2260,"_19":62,"_24":2261,"_26":-7,"_43":-7,"_64":2262,"_21":2260},"api/compute/scheduler/cancel-a-queued-item.mdx","Cancel a queued item DELETE","/docs/api/compute/scheduler/cancel-a-queued-item","api/compute/scheduler/get-this-tenant-s-queue-items.mdx","Get this tenant's queue items GET","/docs/api/compute/scheduler/get-this-tenant-s-queue-items","api/compute/scheduler/index.mdx","/docs/api/compute/scheduler","Quick launches",[2273,2274,2275,2276],"api/compute/quick-launches",{"_36":2270,"_45":2272},"api/compute/quick-launches/meta.json",{"_23":2286,"_19":62,"_24":2268,"_26":1038,"_43":-7,"_64":2287,"_21":2286},{"_23":2283,"_19":62,"_24":2284,"_26":-7,"_43":-7,"_64":2285,"_21":2283},{"_23":2280,"_19":62,"_24":2281,"_26":-7,"_43":-7,"_64":2282,"_21":2280},{"_23":2277,"_19":62,"_24":2278,"_26":-7,"_43":-7,"_64":2279,"_21":2277},"api/compute/quick-launches/preflight-a-quick-launch.mdx","Preflight a quick launch GET","/docs/api/compute/quick-launches/preflight-a-quick-launch","api/compute/quick-launches/get-a-quick-launch-s-progress.mdx","Get a quick launch's progress GET","/docs/api/compute/quick-launches/get-a-quick-launch-s-progress","api/compute/quick-launches/start-a-quick-launch.mdx","Start a quick launch POST","/docs/api/compute/quick-launches/start-a-quick-launch","api/compute/quick-launches/index.mdx","/docs/api/compute/quick-launches","Auto scale groups",[2293,2294,2295,2296,2297,2298],"api/compute/auto-scale-groups",{"_36":2290,"_45":2292},"api/compute/auto-scale-groups/meta.json",{"_23":2314,"_19":62,"_24":2288,"_26":902,"_43":-7,"_64":2315,"_21":2314},{"_23":2311,"_19":62,"_24":2312,"_26":-7,"_43":-7,"_64":2313,"_21":2311},{"_23":2308,"_19":62,"_24":2309,"_26":-7,"_43":-7,"_64":2310,"_21":2308},{"_23":2305,"_19":62,"_24":2306,"_26":-7,"_43":-7,"_64":2307,"_21":2305},{"_23":2302,"_19":62,"_24":2303,"_26":-7,"_43":-7,"_64":2304,"_21":2302},{"_23":2299,"_19":62,"_24":2300,"_26":-7,"_43":-7,"_64":2301,"_21":2299},"api/compute/auto-scale-groups/delete-an-auto-scale-group.mdx","Delete an auto-scale group DELETE","/docs/api/compute/auto-scale-groups/delete-an-auto-scale-group","api/compute/auto-scale-groups/update-an-auto-scale-group.mdx","Update an auto-scale group PUT","/docs/api/compute/auto-scale-groups/update-an-auto-scale-group","api/compute/auto-scale-groups/get-an-auto-scale-group.mdx","Get an auto-scale group GET","/docs/api/compute/auto-scale-groups/get-an-auto-scale-group","api/compute/auto-scale-groups/create-an-auto-scale-group.mdx","Create an auto-scale group POST","/docs/api/compute/auto-scale-groups/create-an-auto-scale-group","api/compute/auto-scale-groups/list-auto-scale-groups.mdx","List auto-scale groups GET","/docs/api/compute/auto-scale-groups/list-auto-scale-groups","api/compute/auto-scale-groups/index.mdx","/docs/api/compute/auto-scale-groups","SSH keys",[2321,2322,2323,2324,2325,2326,2327],"api/compute/ssh-keys",{"_36":2318,"_45":2320},"api/compute/ssh-keys/meta.json",{"_23":2346,"_19":62,"_24":2316,"_26":1196,"_43":-7,"_64":2347,"_21":2346},{"_23":2343,"_19":62,"_24":2344,"_26":-7,"_43":-7,"_64":2345,"_21":2343},{"_23":2340,"_19":62,"_24":2341,"_26":-7,"_43":-7,"_64":2342,"_21":2340},{"_23":2337,"_19":62,"_24":2338,"_26":-7,"_43":-7,"_64":2339,"_21":2337},{"_23":2334,"_19":62,"_24":2335,"_26":-7,"_43":-7,"_64":2336,"_21":2334},{"_23":2331,"_19":62,"_24":2332,"_26":-7,"_43":-7,"_64":2333,"_21":2331},{"_23":2328,"_19":62,"_24":2329,"_26":-7,"_43":-7,"_64":2330,"_21":2328},"api/compute/ssh-keys/generate-an-ssh-key-pair.mdx","Generate an SSH key pair POST","/docs/api/compute/ssh-keys/generate-an-ssh-key-pair","api/compute/ssh-keys/delete-an-ssh-key.mdx","Delete an SSH key DELETE","/docs/api/compute/ssh-keys/delete-an-ssh-key","api/compute/ssh-keys/rename-retag-an-ssh-key.mdx","Rename / retag an SSH key PUT","/docs/api/compute/ssh-keys/rename-retag-an-ssh-key","api/compute/ssh-keys/get-an-ssh-key.mdx","Get an SSH key GET","/docs/api/compute/ssh-keys/get-an-ssh-key","api/compute/ssh-keys/create-an-ssh-key.mdx","Create an SSH key POST","/docs/api/compute/ssh-keys/create-an-ssh-key","api/compute/ssh-keys/list-ssh-keys.mdx","List SSH keys GET","/docs/api/compute/ssh-keys/list-ssh-keys","api/compute/ssh-keys/index.mdx","/docs/api/compute/ssh-keys","Images",[2353,2354,2355,2356,2357,2358],"api/compute/images",{"_36":2350,"_45":2352},"api/compute/images/meta.json",{"_23":2374,"_19":62,"_24":2348,"_26":902,"_43":-7,"_64":2375,"_21":2374},{"_23":2371,"_19":62,"_24":2372,"_26":-7,"_43":-7,"_64":2373,"_21":2371},{"_23":2368,"_19":62,"_24":2369,"_26":-7,"_43":-7,"_64":2370,"_21":2368},{"_23":2365,"_19":62,"_24":2366,"_26":-7,"_43":-7,"_64":2367,"_21":2365},{"_23":2362,"_19":62,"_24":2363,"_26":-7,"_43":-7,"_64":2364,"_21":2362},{"_23":2359,"_19":62,"_24":2360,"_26":-7,"_43":-7,"_64":2361,"_21":2359},"api/compute/images/create-a-tenant-scoped-image-from-one-of-the.mdx","Create a tenant-scoped image from one of the caller's disk snapshots POST","/docs/api/compute/images/create-a-tenant-scoped-image-from-one-of-the","api/compute/images/delete-a-tenant-owned-image.mdx","Delete a tenant-owned image DELETE","/docs/api/compute/images/delete-a-tenant-owned-image","api/compute/images/rename-an-image.mdx","Rename an image PUT","/docs/api/compute/images/rename-an-image","api/compute/images/get-an-image.mdx","Get an image GET","/docs/api/compute/images/get-an-image","api/compute/images/list-images.mdx","List images GET","/docs/api/compute/images/list-images","api/compute/images/index.mdx","/docs/api/compute/images","Instance roles",[2381,2382],"api/compute/instance-roles",{"_36":2378,"_45":2380},"api/compute/instance-roles/meta.json",{"_23":2386,"_19":62,"_24":2376,"_26":68,"_43":-7,"_64":2387,"_21":2386},{"_23":2383,"_19":62,"_24":2384,"_26":-7,"_43":-7,"_64":2385,"_21":2383},"api/compute/instance-roles/list-instance-roles-assigned-to-the-tenant-s-vms.mdx","List instance roles assigned to the tenant's VMs GET","/docs/api/compute/instance-roles/list-instance-roles-assigned-to-the-tenant-s-vms","api/compute/instance-roles/index.mdx","/docs/api/compute/instance-roles","Instance types",[2393,2394,2395],"api/compute/instance-types",{"_36":2390,"_45":2392},"api/compute/instance-types/meta.json",{"_23":2402,"_19":62,"_24":2388,"_26":1055,"_43":-7,"_64":2403,"_21":2402},{"_23":2399,"_19":62,"_24":2400,"_26":-7,"_43":-7,"_64":2401,"_21":2399},{"_23":2396,"_19":62,"_24":2397,"_26":-7,"_43":-7,"_64":2398,"_21":2396},"api/compute/instance-types/get-an-instance-type.mdx","Get an instance type GET","/docs/api/compute/instance-types/get-an-instance-type","api/compute/instance-types/list-instance-types.mdx","List instance types GET","/docs/api/compute/instance-types/list-instance-types","api/compute/instance-types/index.mdx","/docs/api/compute/instance-types","Containers",[2409,2410,2411,2412,2413,2414,2415,2416,2417,2418,2419,2420,2421,2422,2423,2424,2425,2426,2427,2428,2429,2430,2431],"api/compute/containers",{"_36":2406,"_45":2408},"api/compute/containers/meta.json",{"_23":2498,"_19":62,"_24":2404,"_26":2499,"_43":-7,"_64":2500,"_21":2498},{"_23":2495,"_19":62,"_24":2496,"_26":-7,"_43":-7,"_64":2497,"_21":2495},{"_23":2492,"_19":62,"_24":2493,"_26":-7,"_43":-7,"_64":2494,"_21":2492},{"_23":2489,"_19":62,"_24":2490,"_26":-7,"_43":-7,"_64":2491,"_21":2489},{"_23":2486,"_19":62,"_24":2487,"_26":-7,"_43":-7,"_64":2488,"_21":2486},{"_23":2483,"_19":62,"_24":2484,"_26":-7,"_43":-7,"_64":2485,"_21":2483},{"_23":2480,"_19":62,"_24":2481,"_26":-7,"_43":-7,"_64":2482,"_21":2480},{"_23":2477,"_19":62,"_24":2478,"_26":-7,"_43":-7,"_64":2479,"_21":2477},{"_23":2474,"_19":62,"_24":2475,"_26":-7,"_43":-7,"_64":2476,"_21":2474},{"_23":2471,"_19":62,"_24":2472,"_26":-7,"_43":-7,"_64":2473,"_21":2471},{"_23":2468,"_19":62,"_24":2469,"_26":-7,"_43":-7,"_64":2470,"_21":2468},{"_23":2465,"_19":62,"_24":2466,"_26":-7,"_43":-7,"_64":2467,"_21":2465},{"_23":2462,"_19":62,"_24":2463,"_26":-7,"_43":-7,"_64":2464,"_21":2462},{"_23":2459,"_19":62,"_24":2460,"_26":-7,"_43":-7,"_64":2461,"_21":2459},{"_23":2456,"_19":62,"_24":2457,"_26":-7,"_43":-7,"_64":2458,"_21":2456},{"_23":2453,"_19":62,"_24":2454,"_26":-7,"_43":-7,"_64":2455,"_21":2453},{"_23":2450,"_19":62,"_24":2451,"_26":-7,"_43":-7,"_64":2452,"_21":2450},{"_23":2447,"_19":62,"_24":2448,"_26":-7,"_43":-7,"_64":2449,"_21":2447},{"_23":2444,"_19":62,"_24":2445,"_26":-7,"_43":-7,"_64":2446,"_21":2444},{"_23":2441,"_19":62,"_24":2442,"_26":-7,"_43":-7,"_64":2443,"_21":2441},{"_23":2438,"_19":62,"_24":2439,"_26":-7,"_43":-7,"_64":2440,"_21":2438},{"_23":2435,"_19":62,"_24":2436,"_26":-7,"_43":-7,"_64":2437,"_21":2435},{"_23":2432,"_19":62,"_24":2433,"_26":-7,"_43":-7,"_64":2434,"_21":2432},"api/compute/containers/stop-a-container.mdx","Stop a container POST","/docs/api/compute/containers/stop-a-container","api/compute/containers/start-a-container.mdx","Start a container POST","/docs/api/compute/containers/start-a-container","api/compute/containers/move-a-container-to-another-host.mdx","Move a container to another host POST","/docs/api/compute/containers/move-a-container-to-another-host","api/compute/containers/detach-a-nic-from-a-container.mdx","Detach a NIC from a container DELETE","/docs/api/compute/containers/detach-a-nic-from-a-container","api/compute/containers/attach-a-nic-to-a-container.mdx","Attach a NIC to a container POST","/docs/api/compute/containers/attach-a-nic-to-a-container","api/compute/containers/get-container-metric-history.mdx","Get container metric history (chart series) GET","/docs/api/compute/containers/get-container-metric-history","api/compute/containers/download-a-container-s-complete-captured-output.mdx","Download a container's complete captured output: everything the host's size cap pushed into the archive, in order, followed by what is still on the host GET","/docs/api/compute/containers/download-a-container-s-complete-captured-output","api/compute/containers/container-output.mdx","Container output (stdout/stderr) GET","/docs/api/compute/containers/container-output","api/compute/containers/detach-a-disk-from-a-container.mdx","Detach a disk from a container DELETE","/docs/api/compute/containers/detach-a-disk-from-a-container","api/compute/containers/attach-a-disk-to-a-container.mdx","Attach a disk to a container POST","/docs/api/compute/containers/attach-a-disk-to-a-container","api/compute/containers/container-terminal.mdx","Container terminal (WebSocket) GET","/docs/api/compute/containers/container-terminal","api/compute/containers/replace-a-container-s-config-vars.mdx","Replace a container's config vars (persists + best-effort live apply via agent) PUT","/docs/api/compute/containers/replace-a-container-s-config-vars","api/compute/containers/get-a-container-s-config-vars.mdx","Get a container's config vars (env vars) GET","/docs/api/compute/containers/get-a-container-s-config-vars","api/compute/containers/detach-a-managed-database-from-a-container.mdx","Detach a managed database from a container DELETE","/docs/api/compute/containers/detach-a-managed-database-from-a-container","api/compute/containers/attach-a-managed-database-to-a-container.mdx","Attach a managed database to a container (composes its URL into a config var) POST","/docs/api/compute/containers/attach-a-managed-database-to-a-container","api/compute/containers/list-databases-attached-to-a-container.mdx","List databases attached to a container GET","/docs/api/compute/containers/list-databases-attached-to-a-container","api/compute/containers/get-a-container-s-activity-feed.mdx","Get a container's activity feed (reconciler event log) GET","/docs/api/compute/containers/get-a-container-s-activity-feed","api/compute/containers/delete-a-container.mdx","Delete a container DELETE","/docs/api/compute/containers/delete-a-container","api/compute/containers/update-a-container.mdx","Update a container PUT","/docs/api/compute/containers/update-a-container","api/compute/containers/get-a-container.mdx","Get a container GET","/docs/api/compute/containers/get-a-container","api/compute/containers/create-a-container.mdx","Create a container POST","/docs/api/compute/containers/create-a-container","api/compute/containers/list-containers.mdx","List containers GET","/docs/api/compute/containers/list-containers","api/compute/containers/index.mdx","22 operations.","/docs/api/compute/containers","MicroVMs",[2506,2507,2508,2509,2510,2511,2512,2513,2514,2515,2516,2517,2518,2519,2520,2521,2522,2523,2524,2525,2526,2527,2528,2529],"api/compute/microvms",{"_36":2503,"_45":2505},"api/compute/microvms/meta.json",{"_23":2599,"_19":62,"_24":2501,"_26":558,"_43":-7,"_64":2600,"_21":2599},{"_23":2596,"_19":62,"_24":2597,"_26":-7,"_43":-7,"_64":2598,"_21":2596},{"_23":2593,"_19":62,"_24":2594,"_26":-7,"_43":-7,"_64":2595,"_21":2593},{"_23":2590,"_19":62,"_24":2591,"_26":-7,"_43":-7,"_64":2592,"_21":2590},{"_23":2587,"_19":62,"_24":2588,"_26":-7,"_43":-7,"_64":2589,"_21":2587},{"_23":2584,"_19":62,"_24":2585,"_26":-7,"_43":-7,"_64":2586,"_21":2584},{"_23":2581,"_19":62,"_24":2582,"_26":-7,"_43":-7,"_64":2583,"_21":2581},{"_23":2578,"_19":62,"_24":2579,"_26":-7,"_43":-7,"_64":2580,"_21":2578},{"_23":2575,"_19":62,"_24":2576,"_26":-7,"_43":-7,"_64":2577,"_21":2575},{"_23":2572,"_19":62,"_24":2573,"_26":-7,"_43":-7,"_64":2574,"_21":2572},{"_23":2569,"_19":62,"_24":2570,"_26":-7,"_43":-7,"_64":2571,"_21":2569},{"_23":2566,"_19":62,"_24":2567,"_26":-7,"_43":-7,"_64":2568,"_21":2566},{"_23":2563,"_19":62,"_24":2564,"_26":-7,"_43":-7,"_64":2565,"_21":2563},{"_23":2560,"_19":62,"_24":2561,"_26":-7,"_43":-7,"_64":2562,"_21":2560},{"_23":2557,"_19":62,"_24":2558,"_26":-7,"_43":-7,"_64":2559,"_21":2557},{"_23":2554,"_19":62,"_24":2555,"_26":-7,"_43":-7,"_64":2556,"_21":2554},{"_23":2551,"_19":62,"_24":2552,"_26":-7,"_43":-7,"_64":2553,"_21":2551},{"_23":2548,"_19":62,"_24":2549,"_26":-7,"_43":-7,"_64":2550,"_21":2548},{"_23":2545,"_19":62,"_24":2546,"_26":-7,"_43":-7,"_64":2547,"_21":2545},{"_23":2542,"_19":62,"_24":2543,"_26":-7,"_43":-7,"_64":2544,"_21":2542},{"_23":2539,"_19":62,"_24":2540,"_26":-7,"_43":-7,"_64":2541,"_21":2539},{"_23":2536,"_19":62,"_24":2537,"_26":-7,"_43":-7,"_64":2538,"_21":2536},{"_23":2533,"_19":62,"_24":2534,"_26":-7,"_43":-7,"_64":2535,"_21":2533},{"_23":2530,"_19":62,"_24":2531,"_26":-7,"_43":-7,"_64":2532,"_21":2530},"api/compute/microvms/suspend-a-microvm-to-a-memory-snapshot.mdx","Suspend a microVM to a memory snapshot (frees the host) POST","/docs/api/compute/microvms/suspend-a-microvm-to-a-memory-snapshot","api/compute/microvms/stop-a-microvm.mdx","Stop a microVM POST","/docs/api/compute/microvms/stop-a-microvm","api/compute/microvms/start-a-microvm.mdx","Start a microVM POST","/docs/api/compute/microvms/start-a-microvm","api/compute/microvms/resume-a-suspended-microvm-from-its-memory.mdx","Resume a suspended microVM from its memory snapshot POST","/docs/api/compute/microvms/resume-a-suspended-microvm-from-its-memory","api/compute/microvms/move-a-microvm-to-another-host.mdx","Move a microVM to another host POST","/docs/api/compute/microvms/move-a-microvm-to-another-host","api/compute/microvms/reboot-a-microvm.mdx","Reboot a microVM POST","/docs/api/compute/microvms/reboot-a-microvm","api/compute/microvms/detach-a-nic-from-a-microvm.mdx","Detach a NIC from a microVM DELETE","/docs/api/compute/microvms/detach-a-nic-from-a-microvm","api/compute/microvms/attach-a-nic-to-a-microvm.mdx","Attach a NIC to a microVM POST","/docs/api/compute/microvms/attach-a-nic-to-a-microvm","api/compute/microvms/get-microvm-metric-history.mdx","Get microVM metric history (chart series) GET","/docs/api/compute/microvms/get-microvm-metric-history","api/compute/microvms/detach-a-disk-from-a-microvm.mdx","Detach a disk from a microVM DELETE","/docs/api/compute/microvms/detach-a-disk-from-a-microvm","api/compute/microvms/attach-a-disk-to-a-microvm.mdx","Attach a disk to a microVM POST","/docs/api/compute/microvms/attach-a-disk-to-a-microvm","api/compute/microvms/microvm-serial-console.mdx","microVM serial console (WebSocket) GET","/docs/api/compute/microvms/microvm-serial-console","api/compute/microvms/replace-a-microvm-s-config-vars.mdx","Replace a microVM's config vars (persists + best-effort live apply via agent) PUT","/docs/api/compute/microvms/replace-a-microvm-s-config-vars","api/compute/microvms/get-a-microvm-s-config-vars.mdx","Get a microVM's config vars (env vars) GET","/docs/api/compute/microvms/get-a-microvm-s-config-vars","api/compute/microvms/detach-a-managed-database-from-a-microvm.mdx","Detach a managed database from a microVM DELETE","/docs/api/compute/microvms/detach-a-managed-database-from-a-microvm","api/compute/microvms/attach-a-managed-database-to-a-microvm.mdx","Attach a managed database to a microVM (composes its URL into a config var) POST","/docs/api/compute/microvms/attach-a-managed-database-to-a-microvm","api/compute/microvms/list-databases-attached-to-a-microvm.mdx","List databases attached to a microVM GET","/docs/api/compute/microvms/list-databases-attached-to-a-microvm","api/compute/microvms/get-a-microvm-s-activity-feed.mdx","Get a microVM's activity feed (reconciler event log) GET","/docs/api/compute/microvms/get-a-microvm-s-activity-feed","api/compute/microvms/delete-a-microvm.mdx","Delete a microVM DELETE","/docs/api/compute/microvms/delete-a-microvm","api/compute/microvms/update-a-microvm.mdx","Update a microVM PUT","/docs/api/compute/microvms/update-a-microvm","api/compute/microvms/get-a-microvm.mdx","Get a microVM GET","/docs/api/compute/microvms/get-a-microvm","api/compute/microvms/create-a-microvm.mdx","Create a microVM POST","/docs/api/compute/microvms/create-a-microvm","api/compute/microvms/list-microvms.mdx","List microVMs GET","/docs/api/compute/microvms/list-microvms","api/compute/microvms/index.mdx","/docs/api/compute/microvms","Virtual machines",[2606,2607,2608,2609,2610,2611,2612,2613,2614,2615,2616,2617,2618,2619,2620,2621,2622,2623,2624,2625,2626,2627,2628,2629,2630,2631,2632,2633,2634],"api/compute/vms",{"_36":2603,"_45":2605},"api/compute/vms/meta.json",{"_23":2718,"_19":62,"_24":2601,"_26":2719,"_43":-7,"_64":2720,"_21":2718},{"_23":2715,"_19":62,"_24":2716,"_26":-7,"_43":-7,"_64":2717,"_21":2715},{"_23":2712,"_19":62,"_24":2713,"_26":-7,"_43":-7,"_64":2714,"_21":2712},{"_23":2709,"_19":62,"_24":2710,"_26":-7,"_43":-7,"_64":2711,"_21":2709},{"_23":2706,"_19":62,"_24":2707,"_26":-7,"_43":-7,"_64":2708,"_21":2706},{"_23":2703,"_19":62,"_24":2704,"_26":-7,"_43":-7,"_64":2705,"_21":2703},{"_23":2700,"_19":62,"_24":2701,"_26":-7,"_43":-7,"_64":2702,"_21":2700},{"_23":2697,"_19":62,"_24":2698,"_26":-7,"_43":-7,"_64":2699,"_21":2697},{"_23":2694,"_19":62,"_24":2695,"_26":-7,"_43":-7,"_64":2696,"_21":2694},{"_23":2691,"_19":62,"_24":2692,"_26":-7,"_43":-7,"_64":2693,"_21":2691},{"_23":2688,"_19":62,"_24":2689,"_26":-7,"_43":-7,"_64":2690,"_21":2688},{"_23":2685,"_19":62,"_24":2686,"_26":-7,"_43":-7,"_64":2687,"_21":2685},{"_23":2682,"_19":62,"_24":2683,"_26":-7,"_43":-7,"_64":2684,"_21":2682},{"_23":2680,"_19":62,"_24":2214,"_26":-7,"_43":-7,"_64":2681,"_21":2680},{"_23":2677,"_19":62,"_24":2678,"_26":-7,"_43":-7,"_64":2679,"_21":2677},{"_23":2674,"_19":62,"_24":2675,"_26":-7,"_43":-7,"_64":2676,"_21":2674},{"_23":2671,"_19":62,"_24":2672,"_26":-7,"_43":-7,"_64":2673,"_21":2671},{"_23":2668,"_19":62,"_24":2669,"_26":-7,"_43":-7,"_64":2670,"_21":2668},{"_23":2665,"_19":62,"_24":2666,"_26":-7,"_43":-7,"_64":2667,"_21":2665},{"_23":2662,"_19":62,"_24":2663,"_26":-7,"_43":-7,"_64":2664,"_21":2662},{"_23":2659,"_19":62,"_24":2660,"_26":-7,"_43":-7,"_64":2661,"_21":2659},{"_23":2656,"_19":62,"_24":2657,"_26":-7,"_43":-7,"_64":2658,"_21":2656},{"_23":2653,"_19":62,"_24":2654,"_26":-7,"_43":-7,"_64":2655,"_21":2653},{"_23":2650,"_19":62,"_24":2651,"_26":-7,"_43":-7,"_64":2652,"_21":2650},{"_23":2647,"_19":62,"_24":2648,"_26":-7,"_43":-7,"_64":2649,"_21":2647},{"_23":2644,"_19":62,"_24":2645,"_26":-7,"_43":-7,"_64":2646,"_21":2644},{"_23":2641,"_19":62,"_24":2642,"_26":-7,"_43":-7,"_64":2643,"_21":2641},{"_23":2638,"_19":62,"_24":2639,"_26":-7,"_43":-7,"_64":2640,"_21":2638},{"_23":2635,"_19":62,"_24":2636,"_26":-7,"_43":-7,"_64":2637,"_21":2635},"api/compute/vms/suspend-a-vm-to-a-memory-snapshot.mdx","Suspend a VM to a memory snapshot (frees the host) POST","/docs/api/compute/vms/suspend-a-vm-to-a-memory-snapshot","api/compute/vms/stop-a-vm.mdx","Stop a VM POST","/docs/api/compute/vms/stop-a-vm","api/compute/vms/start-a-vm.mdx","Start a VM POST","/docs/api/compute/vms/start-a-vm","api/compute/vms/resume-a-suspended-vm-from-its-memory-snapshot.mdx","Resume a suspended VM from its memory snapshot POST","/docs/api/compute/vms/resume-a-suspended-vm-from-its-memory-snapshot","api/compute/vms/move-a-vm-to-another-host.mdx","Move a VM to another host POST","/docs/api/compute/vms/move-a-vm-to-another-host","api/compute/vms/reboot-a-vm.mdx","Reboot a VM POST","/docs/api/compute/vms/reboot-a-vm","api/compute/vms/get-a-windows-vm-s-administrator-password.mdx","Get a Windows VM's Administrator password, sealed to its SSH key GET","/docs/api/compute/vms/get-a-windows-vm-s-administrator-password","api/compute/vms/detach-a-nic-from-a-vm.mdx","Detach a NIC from a VM DELETE","/docs/api/compute/vms/detach-a-nic-from-a-vm","api/compute/vms/attach-a-nic-to-a-vm.mdx","Attach a NIC to a VM POST","/docs/api/compute/vms/attach-a-nic-to-a-vm","api/compute/vms/get-vm-metric-history.mdx","Get VM metric history (chart series) GET","/docs/api/compute/vms/get-vm-metric-history","api/compute/vms/unmount-the-vm-s-cd-rom-iso.mdx","Unmount the VM's CD-ROM ISO DELETE","/docs/api/compute/vms/unmount-the-vm-s-cd-rom-iso","api/compute/vms/mount-an-iso-into-a-vm-s-cd-rom.mdx","Mount an ISO into a VM's CD-ROM POST","/docs/api/compute/vms/mount-an-iso-into-a-vm-s-cd-rom","api/compute/vms/hard-reboot-a-vm.mdx","Hard-reboot a VM POST","/docs/api/compute/vms/hard-reboot-a-vm","api/compute/vms/force-stop-a-vm.mdx","Force-stop a VM POST","/docs/api/compute/vms/force-stop-a-vm","api/compute/vms/detach-a-disk-from-a-vm.mdx","Detach a disk from a VM DELETE","/docs/api/compute/vms/detach-a-disk-from-a-vm","api/compute/vms/attach-a-disk-to-a-vm.mdx","/docs/api/compute/vms/attach-a-disk-to-a-vm","api/compute/vms/vm-vnc-console.mdx","VM VNC console (WebSocket) GET","/docs/api/compute/vms/vm-vnc-console","api/compute/vms/replace-a-vm-s-config-vars.mdx","Replace a VM's config vars (persists + best-effort live apply via agent) PUT","/docs/api/compute/vms/replace-a-vm-s-config-vars","api/compute/vms/get-a-vm-s-config-vars.mdx","Get a VM's config vars (env vars) GET","/docs/api/compute/vms/get-a-vm-s-config-vars","api/compute/vms/detach-a-managed-database-from-a-vm.mdx","Detach a managed database from a VM DELETE","/docs/api/compute/vms/detach-a-managed-database-from-a-vm","api/compute/vms/attach-a-managed-database-to-a-vm.mdx","Attach a managed database to a VM (composes its URL into a config var) POST","/docs/api/compute/vms/attach-a-managed-database-to-a-vm","api/compute/vms/list-databases-attached-to-a-vm.mdx","List databases attached to a VM GET","/docs/api/compute/vms/list-databases-attached-to-a-vm","api/compute/vms/get-a-vm-s-activity-feed.mdx","Get a VM's activity feed (reconciler event log) GET","/docs/api/compute/vms/get-a-vm-s-activity-feed","api/compute/vms/delete-a-vm.mdx","Delete a VM DELETE","/docs/api/compute/vms/delete-a-vm","api/compute/vms/update-a-vm.mdx","Update a VM PUT","/docs/api/compute/vms/update-a-vm","api/compute/vms/get-a-vm.mdx","Get a VM GET","/docs/api/compute/vms/get-a-vm","api/compute/vms/create-a-vm.mdx","Create a VM POST","/docs/api/compute/vms/create-a-vm","api/compute/vms/list-vms.mdx","List VMs GET","/docs/api/compute/vms/list-vms","api/compute/vms/index.mdx","28 operations.","/docs/api/compute/vms","api/compute/index.mdx","/docs/api/compute","Identity and access","Sign in, second factors, machine credentials, and the roles and permissions that decide what a caller may do.",[2729,2730,2731,2732,2733,2734,2735,2736],"api/identity",{"_36":2726,"_45":2728},"api/identity/meta.json",{"_23":3021,"_19":62,"_24":2723,"_26":2724,"_43":-7,"_64":3022,"_21":3021},{"_19":36,"_24":2969,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2970,"_23":2971,"_21":2972,"_43":-7},{"_19":36,"_24":2877,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2878,"_23":2879,"_21":2880,"_43":-7},{"_19":36,"_24":2837,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2838,"_23":2839,"_21":2840,"_43":-7},{"_19":36,"_24":2809,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2810,"_23":2811,"_21":2812,"_43":-7},{"_19":36,"_24":2773,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2774,"_23":2775,"_21":2776,"_43":-7},{"_19":36,"_24":2761,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2762,"_23":2763,"_21":2764,"_43":-7},{"_19":36,"_24":2737,"_20":-7,"_38":-7,"_26":-7,"_39":-7,"_27":2738,"_23":2739,"_21":2740,"_43":-7},"Tenants",[2742,2743,2744,2745,2746],"api/identity/tenants",{"_36":2739,"_45":2741},"api/identity/tenants/meta.json",{"_23":2759,"_19":62,"_24":2737,"_26":457,"_43":-7,"_64":2760,"_21":2759},{"_23":2756,"_19":62,"_24":2757,"_26":-7,"_43":-7,"_64":2758,"_21":2756},{"_23":2753,"_19":62,"_24":2754,"_26":-7,"_43":-7,"_64":2755,"_21":2753},{"_23":2750,"_19":62,"_24":2751,"_26":-7,"_43":-7,"_64":2752,"_21":2750},{"_23":2747,"_19":62,"_24":2748,"_26":-7,"_43":-7,"_64":2749,"_21":2747},"api/identity/tenants/enable-the-workspace-in-another-availability.mdx","Enable the workspace in another availability zone POST","/docs/api/identity/tenants/enable-the-workspace-in-another-availability","api/identity/tenants/update-a-tenant.mdx","Update a tenant PUT","/docs/api/identity/tenants/update-a-tenant","api/identity/tenants/get-a-tenant.mdx","Get a tenant GET","/docs/api/identity/tenants/get-a-tenant","api/identity/tenants/list-tenants.mdx","List tenants GET","/docs/api/identity/tenants/list-tenants","api/identity/tenants/index.mdx","/docs/api/identity/tenants","Permissions",[2766,2767],"api/identity/permissions",{"_36":2763,"_45":2765},"api/identity/permissions/meta.json",{"_23":2771,"_19":62,"_24":2761,"_26":68,"_43":-7,"_64":2772,"_21":2771},{"_23":2768,"_19":62,"_24":2769,"_26":-7,"_43":-7,"_64":2770,"_21":2768},"api/identity/permissions/list-the-permission-catalog.mdx","List the permission catalog (grouped registry) GET","/docs/api/identity/permissions/list-the-permission-catalog","api/identity/permissions/index.mdx","/docs/api/identity/permissions","Roles",[2778,2779,2780,2781,2782,2783,2784,2785],"api/identity/roles",{"_36":2775,"_45":2777},"api/identity/roles/meta.json",{"_23":2807,"_19":62,"_24":2773,"_26":1986,"_43":-7,"_64":2808,"_21":2807},{"_23":2804,"_19":62,"_24":2805,"_26":-7,"_43":-7,"_64":2806,"_21":2804},{"_23":2801,"_19":62,"_24":2802,"_26":-7,"_43":-7,"_64":2803,"_21":2801},{"_23":2798,"_19":62,"_24":2799,"_26":-7,"_43":-7,"_64":2800,"_21":2798},{"_23":2795,"_19":62,"_24":2796,"_26":-7,"_43":-7,"_64":2797,"_21":2795},{"_23":2792,"_19":62,"_24":2793,"_26":-7,"_43":-7,"_64":2794,"_21":2792},{"_23":2789,"_19":62,"_24":2790,"_26":-7,"_43":-7,"_64":2791,"_21":2789},{"_23":2786,"_19":62,"_24":2787,"_26":-7,"_43":-7,"_64":2788,"_21":2786},"api/identity/roles/revoke-a-permission-from-a-role.mdx","Revoke a permission from a role DELETE","/docs/api/identity/roles/revoke-a-permission-from-a-role","api/identity/roles/grant-a-permission-to-a-role.mdx","Grant a permission to a role POST","/docs/api/identity/roles/grant-a-permission-to-a-role","api/identity/roles/delete-a-role.mdx","Delete a role DELETE","/docs/api/identity/roles/delete-a-role","api/identity/roles/update-a-role.mdx","Update a role PUT","/docs/api/identity/roles/update-a-role","api/identity/roles/get-a-role-by-name.mdx","Get a role by name GET","/docs/api/identity/roles/get-a-role-by-name","api/identity/roles/create-a-role.mdx","Create a role POST","/docs/api/identity/roles/create-a-role","api/identity/roles/list-roles.mdx","List roles GET","/docs/api/identity/roles/list-roles","api/identity/roles/index.mdx","/docs/api/identity/roles","Users",[2814,2815,2816,2817,2818,2819],"api/identity/users",{"_36":2811,"_45":2813},"api/identity/users/meta.json",{"_23":2835,"_19":62,"_24":2809,"_26":902,"_43":-7,"_64":2836,"_21":2835},{"_23":2832,"_19":62,"_24":2833,"_26":-7,"_43":-7,"_64":2834,"_21":2832},{"_23":2829,"_19":62,"_24":2830,"_26":-7,"_43":-7,"_64":2831,"_21":2829},{"_23":2826,"_19":62,"_24":2827,"_26":-7,"_43":-7,"_64":2828,"_21":2826},{"_23":2823,"_19":62,"_24":2824,"_26":-7,"_43":-7,"_64":2825,"_21":2823},{"_23":2820,"_19":62,"_24":2821,"_26":-7,"_43":-7,"_64":2822,"_21":2820},"api/identity/users/delete-a-user.mdx","Delete a user DELETE","/docs/api/identity/users/delete-a-user","api/identity/users/update-a-user.mdx","Update a user PUT","/docs/api/identity/users/update-a-user","api/identity/users/get-a-user.mdx","Get a user GET","/docs/api/identity/users/get-a-user","api/identity/users/create-a-user.mdx","Create a user POST","/docs/api/identity/users/create-a-user","api/identity/users/list-users.mdx","List users GET","/docs/api/identity/users/list-users","api/identity/users/index.mdx","/docs/api/identity/users","API clients",[2842,2843,2844,2845,2846,2847,2848,2849,2850],"api/identity/api-clients",{"_36":2839,"_45":2841},"api/identity/api-clients/meta.json",{"_23":2875,"_19":62,"_24":2837,"_26":181,"_43":-7,"_64":2876,"_21":2875},{"_23":2872,"_19":62,"_24":2873,"_26":-7,"_43":-7,"_64":2874,"_21":2872},{"_23":2869,"_19":62,"_24":2870,"_26":-7,"_43":-7,"_64":2871,"_21":2869},{"_23":2866,"_19":62,"_24":2867,"_26":-7,"_43":-7,"_64":2868,"_21":2866},{"_23":2863,"_19":62,"_24":2864,"_26":-7,"_43":-7,"_64":2865,"_21":2863},{"_23":2860,"_19":62,"_24":2861,"_26":-7,"_43":-7,"_64":2862,"_21":2860},{"_23":2857,"_19":62,"_24":2858,"_26":-7,"_43":-7,"_64":2859,"_21":2857},{"_23":2854,"_19":62,"_24":2855,"_26":-7,"_43":-7,"_64":2856,"_21":2854},{"_23":2851,"_19":62,"_24":2852,"_26":-7,"_43":-7,"_64":2853,"_21":2851},"api/identity/api-clients/scopes-the-caller-may-grant-to-an-api-client.mdx","Scopes the caller may grant to an API client GET","/docs/api/identity/api-clients/scopes-the-caller-may-grant-to-an-api-client","api/identity/api-clients/rotate-an-api-client-s-secret.mdx","Rotate an API client's secret POST","/docs/api/identity/api-clients/rotate-an-api-client-s-secret","api/identity/api-clients/revoke-every-token-issued-to-an-api-client.mdx","Revoke every token issued to an API client POST","/docs/api/identity/api-clients/revoke-every-token-issued-to-an-api-client","api/identity/api-clients/delete-an-api-client.mdx","Delete an API client DELETE","/docs/api/identity/api-clients/delete-an-api-client","api/identity/api-clients/rename-re-describe-or-re-scope-an-api-client.mdx","Rename, re-describe or re-scope an API client PATCH","/docs/api/identity/api-clients/rename-re-describe-or-re-scope-an-api-client","api/identity/api-clients/get-an-api-client.mdx","Get an API client GET","/docs/api/identity/api-clients/get-an-api-client","api/identity/api-clients/create-an-api-client.mdx","Create an API client (client id + secret) POST","/docs/api/identity/api-clients/create-an-api-client","api/identity/api-clients/list-api-clients.mdx","List API clients GET","/docs/api/identity/api-clients/list-api-clients","api/identity/api-clients/index.mdx","/docs/api/identity/api-clients","Authentication",[2882,2883,2884,2885,2886,2887,2888,2889,2890,2891,2892,2893,2894,2895,2896,2897,2898,2899,2900,2901,2902,2903],"api/identity/auth",{"_36":2879,"_45":2881},"api/identity/auth/meta.json",{"_23":2967,"_19":62,"_24":2877,"_26":873,"_43":-7,"_64":2968,"_21":2967},{"_23":2964,"_19":62,"_24":2965,"_26":-7,"_43":-7,"_64":2966,"_21":2964},{"_23":2961,"_19":62,"_24":2962,"_26":-7,"_43":-7,"_64":2963,"_21":2961},{"_23":2958,"_19":62,"_24":2959,"_26":-7,"_43":-7,"_64":2960,"_21":2958},{"_23":2955,"_19":62,"_24":2956,"_26":-7,"_43":-7,"_64":2957,"_21":2955},{"_23":2952,"_19":62,"_24":2953,"_26":-7,"_43":-7,"_64":2954,"_21":2952},{"_23":2949,"_19":62,"_24":2950,"_26":-7,"_43":-7,"_64":2951,"_21":2949},{"_23":2946,"_19":62,"_24":2947,"_26":-7,"_43":-7,"_64":2948,"_21":2946},{"_23":2943,"_19":62,"_24":2944,"_26":-7,"_43":-7,"_64":2945,"_21":2943},{"_23":2940,"_19":62,"_24":2941,"_26":-7,"_43":-7,"_64":2942,"_21":2940},{"_23":2937,"_19":62,"_24":2938,"_26":-7,"_43":-7,"_64":2939,"_21":2937},{"_23":2934,"_19":62,"_24":2935,"_26":-7,"_43":-7,"_64":2936,"_21":2934},{"_23":2931,"_19":62,"_24":2932,"_26":-7,"_43":-7,"_64":2933,"_21":2931},{"_23":2928,"_19":62,"_24":2929,"_26":-7,"_43":-7,"_64":2930,"_21":2928},{"_23":2925,"_19":62,"_24":2926,"_26":-7,"_43":-7,"_64":2927,"_21":2925},{"_23":2922,"_19":62,"_24":2923,"_26":-7,"_43":-7,"_64":2924,"_21":2922},{"_23":2919,"_19":62,"_24":2920,"_26":-7,"_43":-7,"_64":2921,"_21":2919},{"_23":2916,"_19":62,"_24":2917,"_26":-7,"_43":-7,"_64":2918,"_21":2916},{"_23":2913,"_19":62,"_24":2914,"_26":-7,"_43":-7,"_64":2915,"_21":2913},{"_23":2910,"_19":62,"_24":2911,"_26":-7,"_43":-7,"_64":2912,"_21":2910},{"_23":2907,"_19":62,"_24":2908,"_26":-7,"_43":-7,"_64":2909,"_21":2907},{"_23":2904,"_19":62,"_24":2905,"_26":-7,"_43":-7,"_64":2906,"_21":2904},"api/identity/auth/confirm-an-email-address-with-a-verification.mdx","Confirm an email address with a verification token POST","/docs/api/identity/auth/confirm-an-email-address-with-a-verification","api/identity/auth/return-oidc-userinfo.mdx","Return OIDC userinfo GET","/docs/api/identity/auth/return-oidc-userinfo","api/identity/auth/start-authenticator-app-enrolment.mdx","Start authenticator-app enrolment POST","/docs/api/identity/auth/start-authenticator-app-enrolment","api/identity/auth/replace-the-caller-s-recovery-codes.mdx","Replace the caller's recovery codes POST","/docs/api/identity/auth/replace-the-caller-s-recovery-codes","api/identity/auth/finish-authenticator-app-enrolment-and-receive.mdx","Finish authenticator-app enrolment and receive recovery codes POST","/docs/api/identity/auth/finish-authenticator-app-enrolment-and-receive","api/identity/auth/turn-the-authenticator-app-off.mdx","Turn the authenticator app off DELETE","/docs/api/identity/auth/turn-the-authenticator-app-off","api/identity/auth/refresh-an-access-token.mdx","Refresh an access token POST","/docs/api/identity/auth/refresh-an-access-token","api/identity/auth/sign-out-everywhere-every-token-issued-to-the.mdx","Sign out everywhere: every token issued to the caller so far is revoked POST","/docs/api/identity/auth/sign-out-everywhere-every-token-issued-to-the","api/identity/auth/mail-the-caller-a-fresh-verification-link.mdx","Mail the caller a fresh verification link POST","/docs/api/identity/auth/mail-the-caller-a-fresh-verification-link","api/identity/auth/return-the-caller-s-sign-in-security-state.mdx","Return the caller's sign-in security state GET","/docs/api/identity/auth/return-the-caller-s-sign-in-security-state","api/identity/auth/set-a-new-password-with-a-reset-token.mdx","Set a new password with a reset token POST","/docs/api/identity/auth/set-a-new-password-with-a-reset-token","api/identity/auth/register-a-new-tenant-user.mdx","Register a new tenant + user POST","/docs/api/identity/auth/register-a-new-tenant-user","api/identity/auth/complete-a-second-factor-challenge.mdx","Complete a second-factor challenge POST","/docs/api/identity/auth/complete-a-second-factor-challenge","api/identity/auth/resend-the-emailed-code-for-a-challenge.mdx","Resend the emailed code for a challenge POST","/docs/api/identity/auth/resend-the-emailed-code-for-a-challenge","api/identity/auth/sign-out-revoke-the-presented-access-token.mdx","Sign out: revoke the presented access token (and the refresh token, if sent) POST","/docs/api/identity/auth/sign-out-revoke-the-presented-access-token","api/identity/auth/exchange-credentials-for-an-oauth-2-0-token-or.mdx","Exchange credentials for an OAuth 2.0 token, or open a second-factor challenge POST","/docs/api/identity/auth/exchange-credentials-for-an-oauth-2-0-token-or","api/identity/auth/set-the-language-this-account-s-mail-is-written.mdx","Set the language this account's mail is written in PUT","/docs/api/identity/auth/set-the-language-this-account-s-mail-is-written","api/identity/auth/mail-a-password-reset-link.mdx","Mail a password-reset link POST","/docs/api/identity/auth/mail-a-password-reset-link","api/identity/auth/forget-one-remembered-browser.mdx","Forget one remembered browser DELETE","/docs/api/identity/auth/forget-one-remembered-browser","api/identity/auth/forget-every-remembered-browser.mdx","Forget every remembered browser DELETE","/docs/api/identity/auth/forget-every-remembered-browser","api/identity/auth/change-the-caller-s-password.mdx","Change the caller's password POST","/docs/api/identity/auth/change-the-caller-s-password","api/identity/auth/index.mdx","/docs/api/identity/auth","OAuth 2.1",[2974,2975,2976,2977,2978,2979,2980,2981,2982,2983,2984,2985],"api/identity/oauth",{"_36":2971,"_45":2973},"api/identity/oauth/meta.json",{"_23":3019,"_19":62,"_24":2969,"_26":1748,"_43":-7,"_64":3020,"_21":3019},{"_23":3016,"_19":62,"_24":3017,"_26":-7,"_43":-7,"_64":3018,"_21":3016},{"_23":3013,"_19":62,"_24":3014,"_26":-7,"_43":-7,"_64":3015,"_21":3013},{"_23":3010,"_19":62,"_24":3011,"_26":-7,"_43":-7,"_64":3012,"_21":3010},{"_23":3007,"_19":62,"_24":3008,"_26":-7,"_43":-7,"_64":3009,"_21":3007},{"_23":3004,"_19":62,"_24":3005,"_26":-7,"_43":-7,"_64":3006,"_21":3004},{"_23":3001,"_19":62,"_24":3002,"_26":-7,"_43":-7,"_64":3003,"_21":3001},{"_23":2998,"_19":62,"_24":2999,"_26":-7,"_43":-7,"_64":3000,"_21":2998},{"_23":2995,"_19":62,"_24":2996,"_26":-7,"_43":-7,"_64":2997,"_21":2995},{"_23":2992,"_19":62,"_24":2993,"_26":-7,"_43":-7,"_64":2994,"_21":2992},{"_23":2989,"_19":62,"_24":2990,"_26":-7,"_43":-7,"_64":2991,"_21":2989},{"_23":2986,"_19":62,"_24":2987,"_26":-7,"_43":-7,"_64":2988,"_21":2986},"api/identity/oauth/claims-about-the-signed-in-user.mdx","Claims about the signed-in user GET","/docs/api/identity/oauth/claims-about-the-signed-in-user","api/identity/oauth/issue-an-access-token.mdx","Issue an access token POST","/docs/api/identity/oauth/issue-an-access-token","api/identity/oauth/establish-the-single-sign-on-cookie.mdx","Establish the single sign-on cookie POST","/docs/api/identity/oauth/establish-the-single-sign-on-cookie","api/identity/oauth/revoke-a-token.mdx","Revoke a token POST","/docs/api/identity/oauth/revoke-a-token","api/identity/oauth/register-a-client-dynamically.mdx","Register a client dynamically POST","/docs/api/identity/oauth/register-a-client-dynamically","api/identity/oauth/submit-credentials-for-an-authorization-code.mdx","Submit credentials for an authorization code flow POST","/docs/api/identity/oauth/submit-credentials-for-an-authorization-code","api/identity/oauth/start-an-authorization-code-flow.mdx","Start an authorization code flow GET","/docs/api/identity/oauth/start-an-authorization-code-flow","api/identity/oauth/openid-connect-discovery-document.mdx","OpenID Connect discovery document GET","/docs/api/identity/oauth/openid-connect-discovery-document","api/identity/oauth/protected-resource-metadata.mdx","Protected resource metadata GET","/docs/api/identity/oauth/protected-resource-metadata","api/identity/oauth/authorization-server-metadata.mdx","Authorization server metadata GET","/docs/api/identity/oauth/authorization-server-metadata","api/identity/oauth/signing-keys.mdx","Signing keys GET","/docs/api/identity/oauth/signing-keys","api/identity/oauth/index.mdx","/docs/api/identity/oauth","api/identity/index.mdx","/docs/api/identity","api/index.mdx","Every route the Interlaken orchestrator serves.","/docs/api","_2","separator","Reference","cli.mdx","The interlaken CLI","A small command that holds your credentials, keeps a token fresh, and makes authenticated calls.","/docs/cli","Requests and responses","The rules that hold across every route.",[3039,3040,3041,3042],"conventions",{"_36":3036,"_45":3038},"conventions/meta.json",{"_23":3055,"_19":62,"_24":3033,"_26":3056,"_43":-7,"_64":3057,"_21":3055},{"_23":3051,"_19":62,"_24":3052,"_26":3053,"_43":-7,"_64":3054,"_21":3051},{"_23":3047,"_19":62,"_24":3048,"_26":3049,"_43":-7,"_64":3050,"_21":3047},{"_23":3043,"_19":62,"_24":3044,"_26":3045,"_43":-7,"_64":3046,"_21":3043},"conventions/zones.mdx","Availability zones","Each zone is its own deployment with its own API. What that means for your code.","/docs/conventions/zones","conventions/errors.mdx","Errors","The status codes, the shape of a failure body, and which failures are worth retrying.","/docs/conventions/errors","conventions/pagination.mdx","Pagination, filtering and sorting","The query parameters every collection accepts, and what the numbers mean.","/docs/conventions/pagination","conventions/index.mdx","Base URLs, content types, identifiers, and why a 201 does not mean the machine is running.","/docs/conventions","_1","Working with the API","How a caller proves who it is, and what that proof allows.",[3065,3066,3067,3068,3069],"authentication",{"_36":3062,"_45":3064},"authentication/meta.json",{"_23":3085,"_19":62,"_24":2877,"_26":3086,"_43":-7,"_64":3087,"_21":3085},{"_23":3082,"_19":62,"_24":2837,"_26":3083,"_43":-7,"_64":3084,"_21":3082},{"_23":3078,"_19":62,"_24":3079,"_26":3080,"_43":-7,"_64":3081,"_21":3078},{"_23":3074,"_19":62,"_24":3075,"_26":3076,"_43":-7,"_64":3077,"_21":3074},{"_23":3070,"_19":62,"_24":3071,"_26":3072,"_43":-7,"_64":3073,"_21":3070},"authentication/tokens.mdx","Verifying a token","The signing keys, the claims inside a token, and why expiry is not the only thing that ends one.","/docs/authentication/tokens","authentication/sessions.mdx","Users, sessions and second factors","Password sign-in, emailed codes, authenticator apps and remembered browsers.","/docs/authentication/sessions","authentication/permissions.mdx","Permissions and scopes","How a permission key is written, how a token's scope narrows it, and what a 403 is telling you.","/docs/authentication/permissions","authentication/api-clients.mdx","The credential a program uses. Creating one, scoping it, rotating it, and taking it away.","/docs/authentication/api-clients","authentication/index.mdx","Bearer tokens, where they come from, and which flow belongs to which kind of caller.","/docs/authentication","_0","quickstart.mdx","Your first request","From a fresh account to a working API call.","/docs/quickstart","index.mdx","Interlaken for developers","What the orchestrator API is, and the shortest path to calling it.","/docs","meta.json","docs",{},"proxyUrl"]