{ "info": { "_postman_id": "a354e160-8e9e-5b94-bae8-6f53110591ca", "name": "Adios.dev API — Core reference", "description": "# Adios.dev API\n\nDeploy and operate applications, work with source-backed workspaces, manage\ndomains and object storage, and inspect AI agent sessions through the Adios API.\n\nThis collection documents the core customer-facing API. It includes editable\nrequest bodies, resource variables, pagination controls, and illustrative\nresponses. It is a curated reference, not a dump of every platform route.\n\n## Get started\n\n1. Create an account at [Adios.dev](https://adios.dev) and sign in to the\n [Adios app](https://app.adios.dev).\n2. Fork this collection into your own workspace. Import the supplied Production\n environment, or create a private environment containing `base_url`,\n `access_token`, and `team_id`.\n3. Set `base_url` to `https://api.adios.dev` without a trailing slash.\n4. Obtain a bearer token as described below and set `access_token` in your\n private environment. Set `team_id` to the same team selected in your CLI.\n5. Send **Check API health**, then **Get current user**. The latter saves your\n `user_id` in the selected environment. Choose **List workloads** to inspect\n your team's applications.\n\nThe companion **Adios.dev API — Quick start** collection contains five read-only\nrequests that can be run in order. Send requests in the core reference\nindividually: it contains creates, updates, deletes, email invitations, and\nruntime operations.\n\n## Authentication\n\nProtected requests inherit `Authorization: Bearer {{access_token}}` from the\ncollection. Team-scoped requests send `X-Tenant-ID: {{team_id}}`.\n\nFor manual API access, a **team administrator** can use the supported CLI\ndiagnostic-token flow:\n\n```sh\nadios login\nadios teams\nadios teams switch YOUR_TEAM_ID\nadios auth print-token --ttl 15m\n```\n\nInstall the CLI on macOS or Linux with `brew install adiosdotdev/tap/adios`.\nCopy the printed token into your private Postman environment. Diagnostic tokens\nexpire after 1–15 minutes (the command above requests 15 minutes), cannot be\nrefreshed, and remain bound to the selected team. Mint a new token when it expires.\nAccount and team permissions still apply to every request.\n\nThe password grant is disabled and password login requires signed requests.\nThis REST collection does not offer a password-based or one-click Postman OAuth\nlogin. Postman's native MCP integration uses a separate, MCP-scoped OAuth flow\nwhose tokens cannot call general REST routes. Raw CLI tokens are DPoP-bound\nand cannot simply be pasted into Bearer auth; use `adios auth print-token`.\nNon-admin users need an authorized bearer credential compatible with their\ndeployment; this collection does not provision one.\n\nKeep tokens in your private fork/environment. Leave shared values empty and\nnever publish authenticated response captures or environments containing tokens.\nPublic health and plan-catalog requests explicitly use **No Auth**.\n\n## Using the reference\n\n- Copy IDs returned by list/create requests into the corresponding environment\n variables, such as `workload_id`, `workspace_id`, or `object_bucket_id`.\n The collection never selects a team or target resource automatically.\n- Set `region` from **Get deployment context**, `hostname` to a domain you own,\n and `bucket_name` to a globally unique name before using those examples.\n- Optional query parameters appear disabled. Enable the ones you need.\n Generated list routes support `page` (default 1) and `per_page` (default 20,\n maximum 100), with results in `data` and pagination metadata in `pagination`.\n- Request descriptions list available fields for generated CRUD operations.\n Replace example values and review resource configuration before sending.\n- Bucket uploads use **Body → binary**. Select a local file; do not send a\n multipart form. Downloads can return arbitrary content types.\n- Build, deploy, preview, and workflow operations may consume paid resources or\n perform configured external actions. Workspace file/tree reads can hydrate\n source. Runtime actions can require an active subscription.\n- Saved response examples are synthetic illustrations derived from the schema,\n not captures from production. Custom routes without a complete response\n contract omit examples rather than presenting an invented payload.\n\n## Responses and troubleshooting\n\nSuccessful requests return a 2xx status. The collection checks this after each\nrequest. A failed assertion indicates a response to investigate; it does not\nvalidate the entire response schema or prove that a deployment became healthy.\n\n| Status | What to check |\n| --- | --- |\n| 400 | Required values, request body, IDs, and `X-Tenant-ID`. |\n| 401 | Missing, expired, or incompatible bearer token. |\n| 402 | Subscription or resource entitlement required for the operation. |\n| 403 | Team membership, role, resource permission, or token/team mismatch. |\n| 404 | Resource ID and active team. |\n| 409 | Conflicting resource state or operation. |\n| 429 | Wait before retrying; honor `Retry-After` when present. |\n| 5xx | Service availability; retain the response for private troubleshooting. |\n\n## Coverage\n\nThe core reference covers teams and invitations; workloads, builds, and runtime\nstatus; workspaces, files, previews, and commands; workspace sources and source\nartifact reads; workflows; domains; object buckets, objects, and access keys;\ngateway routes and security profiles; agent sessions and read-only run/message/\nplan/event records; feature planning; webhook configuration; AI model settings;\nbilling reads; and authorized OAuth connections.\n\nPlatform administration, service-to-service credentials, provider callbacks,\nbrowser account flows, internal accounting/execution ledgers,\nand advanced agent-catalog/automation operations are outside this edition.\nThe API specification can contain more routes than this curated reference.\n\nFor MCP, use the companion **Adios.dev MCP — Public discovery** collection and\nthe native MCP HTTP or STDIO connection configurations. The hosted endpoint is\n`https://api.adios.dev/v1/mcp`; native MCP setup and its OAuth requirements are\ndocumented separately from the REST collection.\n\nProduct information: [adios.dev](https://adios.dev).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": "1.0.0" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Response is successful (2xx)', function () {", " pm.expect(pm.response.code).to.be.within(200, 299);", "});" ] } } ], "item": [ { "name": "Quick start", "description": "Start with API health, then verify your bearer token and team context.", "item": [ { "id": "207e12b7-5e00-5990-ac1b-f694cb3330bc", "name": "Check API health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/health", "host": [ "{{base_url}}" ], "path": [ "v1", "health" ] }, "auth": { "type": "noauth" }, "description": "Check whether the API process is responding." }, "response": [ { "id": "894f7d59-8a3b-5305-bdec-0562cf0124e7", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/health", "host": [ "{{base_url}}" ], "path": [ "v1", "health" ] }, "auth": { "type": "noauth" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" } ] }, { "id": "62ee2193-db68-551d-a811-5d5c3b59d0a6", "name": "Get current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/auth/me", "host": [ "{{base_url}}" ], "path": [ "v1", "auth", "me" ] }, "description": "Return your user_id, profile, teams, and team_data. The response script saves only user_id in the selected environment. Set team_id yourself to the active CLI team before using a diagnostic token." }, "response": [], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 200 && pm.environment.name) {", " const data = pm.response.json();", " if (typeof data.user_id === 'string' && data.user_id) {", " pm.environment.set('user_id', data.user_id);", " }", "}" ] } } ] } ] }, { "name": "Teams", "description": "Manage teams and membership. Requests remain subject to your account and team permissions.", "item": [ { "id": "d1b5e4ca-77e3-5bb4-aa5a-ada88b28f263", "name": "List teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team", "host": [ "{{base_url}}" ], "path": [ "v1", "team" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of Team" }, "response": [ { "id": "9950881c-379c-5318-8c39-24076012fc7b", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team", "host": [ "{{base_url}}" ], "path": [ "v1", "team" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"owner_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "f194848b-a296-5f2f-94ff-71bf8623c464", "name": "Create team", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/team", "host": [ "{{base_url}}" ], "path": [ "v1", "team" ] }, "body": { "mode": "raw", "raw": "{\n \"owner_id\": \"{{user_id}}\",\n \"title\": \"Postman example team\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new Team\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `description` | string | no | Default: `\"\"`. |\n| `owner_id` | string | yes | |\n| `parent_id` | string | no | |\n| `status` | string | yes | Allowed: active, inactive, suspended, deleted. Default: `\"active\"`. |\n| `title` | string | yes | |" }, "response": [ { "id": "c7576bd2-5c6c-5472-be6f-7c874b1e4eb9", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/team", "host": [ "{{base_url}}" ], "path": [ "v1", "team" ] }, "body": { "mode": "raw", "raw": "{\n \"owner_id\": \"{{user_id}}\",\n \"title\": \"Postman example team\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"owner_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000\n}" } ] }, { "id": "602d4fa1-0ec9-5753-9d91-7617ecac15f0", "name": "Get team", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/{{team_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "{{team_id}}" ] }, "description": "Returns a single Team\n\nSet `team_id` using IDs from your own API responses." }, "response": [ { "id": "4ea29062-486a-515d-8813-c7051208e73d", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/{{team_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "{{team_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"owner_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000\n}" } ] }, { "id": "5cd63bb2-9cf0-5dbf-b1a4-6d0441626122", "name": "Update team", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/team/{{team_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "{{team_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"owner_id\": \"{{user_id}}\",\n \"title\": \"Postman example team\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing Team\n\nSet `team_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `description` | string | no | Default: `\"\"`. |\n| `owner_id` | string | yes | |\n| `parent_id` | string | no | |\n| `status` | string | yes | Allowed: active, inactive, suspended, deleted. Default: `\"active\"`. |\n| `title` | string | yes | |" }, "response": [ { "id": "100fde48-77e2-58a0-8c2e-8b7359f35be0", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/team/{{team_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "{{team_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"owner_id\": \"{{user_id}}\",\n \"title\": \"Postman example team\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"owner_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000\n}" } ] }, { "id": "0b1582d3-5501-5fce-8e60-13ea733058c0", "name": "Delete team", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/{{team_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "{{team_id}}" ] }, "description": "Deletes a Team\n\nSet `team_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "59ca1641-f0f3-5f15-9ce9-ae479c835625", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/{{team_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "{{team_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "15253843-df5f-5f6b-beb9-8a113c79bb32", "name": "Get deployment context", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/deployment-context", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "deployment-context" ] }, "description": "Discover available deployment regions and the active team deployment context." }, "response": [] }, { "id": "85807bc1-c5d0-5927-b460-cb35d8bd054a", "name": "List team members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/members", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "members" ] }, "description": "List members of the selected team." }, "response": [] }, { "id": "3529d6c7-e7cc-53c7-b210-10a3e6110861", "name": "List team invitations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/invitations", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "invitations" ] }, "description": "List invitations for the selected team." }, "response": [] }, { "id": "e355ad70-09b3-55c4-a322-b9a403f7c5b4", "name": "Invite a team member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/team/invitations", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "invitations" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"{{invite_email}}\",\n \"role\": \"user\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Send an email invitation to join the selected team. role supports user, manager, or team_admin.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "7dba8125-8f76-5ee7-aa13-1f15e63e7616", "name": "Resend team invitation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/invitations/{{invitation_id}}/resend", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "invitations", "{{invitation_id}}", "resend" ] }, "description": "Send the invitation email again.\n\nSet `invitation_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "cc5ae878-3bba-55d0-b747-cba05d4f86f7", "name": "Revoke team invitation", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/invitations/{{invitation_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "invitations", "{{invitation_id}}" ] }, "description": "Revoke a pending invitation.\n\nSet `invitation_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] } ] }, { "name": "Workloads", "description": "Manage applications and runtimes. Build and deploy actions can consume paid resources; use a disposable workload when trying examples. Set workload_image to an image or rootfs supported by your deployment configuration and region to an available region from Get deployment context.", "item": [ { "id": "cdbac455-3ce1-5840-91d4-67d0a9f61c98", "name": "List workloads", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload", "host": [ "{{base_url}}" ], "path": [ "v1", "workload" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of Workload" }, "response": [ { "id": "2c19317c-74ae-51b9-9348-33ad6f07bdb8", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload", "host": [ "{{base_url}}" ], "path": [ "v1", "workload" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"allow_default_domain\": true,\n \"branch\": \"main\",\n \"build_id\": \"example\",\n \"config\": {},\n \"created_at\": 1791072000,\n \"current_source_artifact_id\": \"\",\n \"deleted_at\": 0,\n \"domain\": \"example\",\n \"env_vars\": {},\n \"image\": \"example\",\n \"name\": \"postman-example\",\n \"node_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"port\": 8080,\n \"region\": \"default\",\n \"repository_url\": \"example\",\n \"requires\": {},\n \"resources\": {},\n \"status\": \"provisioning\",\n \"team_id\": \"000000000000000000000000001\",\n \"template\": \"example\",\n \"type\": \"api\",\n \"updated_at\": 1791072000,\n \"variant\": \"\",\n \"version\": \"example\",\n \"volumes\": {},\n \"workload_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "68488fa7-5f0e-58f4-ad9f-1605af8a0b3b", "name": "Create workload", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workload", "host": [ "{{base_url}}" ], "path": [ "v1", "workload" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"postman-example\",\n \"type\": \"api\",\n \"image\": \"{{workload_image}}\",\n \"allow_default_domain\": true,\n \"port\": 8080,\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new Workload\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `allow_default_domain` | boolean | yes | Whether to allow access via the default *.adios.run domain when a custom domain is configured Default: `true`. |\n| `branch` | string | no | Git branch or tag Default: `\"main\"`. |\n| `build_id` | string | no | Link to specific build artifact |\n| `config` | object | no | Workload specific configuration (e.g. cron schedule, queue name, db user) |\n| `current_source_artifact_id` | string | no | API source artifact record for the currently deployed build Default: `\"\"`. |\n| `domain` | string | no | Generated *.adios.run hostname or a verified user-owned custom domain; *.adios.dev and custom *.adios.run assignments are reserved |\n| `env_vars` | object | no | |\n| `image` | string | yes | Docker image or rootfs location |\n| `name` | string | yes | |\n| `node_id` | string | no | |\n| `parent_id` | string | no | |\n| `port` | integer | no | Network port the workload listens on Default: `8080`. |\n| `region` | string | no | Default: `\"default\"`. |\n| `repository_url` | string | no | Git repository URL |\n| `requires` | object | no | List of required capabilities or services |\n| `resources` | object | no | Resource requirements (cpu, ram, disk) |\n| `status` | string | no | Default: `\"provisioning\"`. |\n| `team_id` | string | yes | |\n| `template` | string | no | Template name and version (e.g. postgres:16) |\n| `type` | string | yes | Allowed: app, api, worker, function, cron, queue, database, cache. Default: `\"api\"`. |\n| `variant` | string | no | Default: `\"\"`. |\n| `version` | string | no | Semantic version or commit hash |\n| `volumes` | object | no | List of volume mounts |" }, "response": [ { "id": "bb05dae6-00c2-5bf2-a5ff-fb1d2aaf7ba2", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workload", "host": [ "{{base_url}}" ], "path": [ "v1", "workload" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"postman-example\",\n \"type\": \"api\",\n \"image\": \"{{workload_image}}\",\n \"allow_default_domain\": true,\n \"port\": 8080,\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"allow_default_domain\": true,\n \"branch\": \"main\",\n \"build_id\": \"example\",\n \"config\": {},\n \"created_at\": 1791072000,\n \"current_source_artifact_id\": \"\",\n \"deleted_at\": 0,\n \"domain\": \"example\",\n \"env_vars\": {},\n \"image\": \"example\",\n \"name\": \"postman-example\",\n \"node_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"port\": 8080,\n \"region\": \"default\",\n \"repository_url\": \"example\",\n \"requires\": {},\n \"resources\": {},\n \"status\": \"provisioning\",\n \"team_id\": \"000000000000000000000000001\",\n \"template\": \"example\",\n \"type\": \"api\",\n \"updated_at\": 1791072000,\n \"variant\": \"\",\n \"version\": \"example\",\n \"volumes\": {},\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "c4faa70d-85e3-51a4-94ca-2575d9af7e0c", "name": "Get workload", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}" ] }, "description": "Returns a single Workload\n\nSet `workload_id` using IDs from your own API responses." }, "response": [ { "id": "ee2fcbce-7b9d-5b18-af83-5c7c000d086d", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"allow_default_domain\": true,\n \"branch\": \"main\",\n \"build_id\": \"example\",\n \"config\": {},\n \"created_at\": 1791072000,\n \"current_source_artifact_id\": \"\",\n \"deleted_at\": 0,\n \"domain\": \"example\",\n \"env_vars\": {},\n \"image\": \"example\",\n \"name\": \"postman-example\",\n \"node_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"port\": 8080,\n \"region\": \"default\",\n \"repository_url\": \"example\",\n \"requires\": {},\n \"resources\": {},\n \"status\": \"provisioning\",\n \"team_id\": \"000000000000000000000000001\",\n \"template\": \"example\",\n \"type\": \"api\",\n \"updated_at\": 1791072000,\n \"variant\": \"\",\n \"version\": \"example\",\n \"volumes\": {},\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "bc552354-d015-5572-9644-6c7647255847", "name": "Update workload", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"postman-example\",\n \"type\": \"api\",\n \"image\": \"{{workload_image}}\",\n \"allow_default_domain\": true,\n \"port\": 8080,\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing Workload\n\nSet `workload_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `allow_default_domain` | boolean | yes | Whether to allow access via the default *.adios.run domain when a custom domain is configured Default: `true`. |\n| `branch` | string | no | Git branch or tag Default: `\"main\"`. |\n| `build_id` | string | no | Link to specific build artifact |\n| `config` | object | no | Workload specific configuration (e.g. cron schedule, queue name, db user) |\n| `current_source_artifact_id` | string | no | API source artifact record for the currently deployed build Default: `\"\"`. |\n| `domain` | string | no | Generated *.adios.run hostname or a verified user-owned custom domain; *.adios.dev and custom *.adios.run assignments are reserved |\n| `env_vars` | object | no | |\n| `image` | string | yes | Docker image or rootfs location |\n| `name` | string | yes | |\n| `node_id` | string | no | |\n| `parent_id` | string | no | |\n| `port` | integer | no | Network port the workload listens on Default: `8080`. |\n| `region` | string | no | Default: `\"default\"`. |\n| `repository_url` | string | no | Git repository URL |\n| `requires` | object | no | List of required capabilities or services |\n| `resources` | object | no | Resource requirements (cpu, ram, disk) |\n| `status` | string | no | Default: `\"provisioning\"`. |\n| `team_id` | string | yes | |\n| `template` | string | no | Template name and version (e.g. postgres:16) |\n| `type` | string | yes | Allowed: app, api, worker, function, cron, queue, database, cache. Default: `\"api\"`. |\n| `variant` | string | no | Default: `\"\"`. |\n| `version` | string | no | Semantic version or commit hash |\n| `volumes` | object | no | List of volume mounts |" }, "response": [ { "id": "c7e71630-986c-52bb-8c45-4d35dfbb9643", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"postman-example\",\n \"type\": \"api\",\n \"image\": \"{{workload_image}}\",\n \"allow_default_domain\": true,\n \"port\": 8080,\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"allow_default_domain\": true,\n \"branch\": \"main\",\n \"build_id\": \"example\",\n \"config\": {},\n \"created_at\": 1791072000,\n \"current_source_artifact_id\": \"\",\n \"deleted_at\": 0,\n \"domain\": \"example\",\n \"env_vars\": {},\n \"image\": \"example\",\n \"name\": \"postman-example\",\n \"node_id\": \"000000000000000000000000001\",\n \"parent_id\": \"000000000000000000000000001\",\n \"port\": 8080,\n \"region\": \"default\",\n \"repository_url\": \"example\",\n \"requires\": {},\n \"resources\": {},\n \"status\": \"provisioning\",\n \"team_id\": \"000000000000000000000000001\",\n \"template\": \"example\",\n \"type\": \"api\",\n \"updated_at\": 1791072000,\n \"variant\": \"\",\n \"version\": \"example\",\n \"volumes\": {},\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "b5f7d1a1-7628-59ce-8f43-b28fc29dd9ed", "name": "Delete workload", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}" ] }, "description": "Deletes a Workload\n\nSet `workload_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "e10b920a-0eeb-5f0d-886f-8e73d86b3234", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "565379de-b2d3-52d6-88b6-638528bda3c7", "name": "Build workload from repository", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/build?async=true", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "build" ], "query": [ { "key": "repo", "value": "{{repository_url}}", "description": "Override the configured Git repository.", "disabled": true }, { "key": "branch", "value": "main", "description": "Override the repository branch.", "disabled": true }, { "key": "async", "value": "true", "description": "Return while the build runs in the background.", "disabled": false } ] }, "description": "Build the workload using its configured repository. Set repository_url on the workload first, or enable repo here. A paid subscription may be required.\n\nSet `workload_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "f439002b-e18c-51d1-a093-fc675320787b", "name": "Deploy workload", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/deploy", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "deploy" ], "query": [ { "key": "build_id", "value": "{{build_id}}", "description": "Deploy a previously built artifact.", "disabled": true }, { "key": "region", "value": "{{region}}", "description": "Override the deployment region.", "disabled": true } ] }, "description": "Build and deploy from the configured repository or deploy an existing build_id. This changes the running workload and may incur usage charges.\n\nSet `workload_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "4ef3f097-edea-548d-9e7a-a67ec79e1244", "name": "List workload builds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/builds", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "builds" ] }, "description": "List build history for the workload.\n\nSet `workload_id` using IDs from your own API responses." }, "response": [] }, { "id": "908ea12a-76c3-54cb-93d5-c60cea660172", "name": "Get build logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/builds/{{build_id}}/logs", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "builds", "{{build_id}}", "logs" ], "query": [ { "key": "lines", "value": "100", "description": "Maximum requested log lines.", "disabled": true }, { "key": "follow", "value": "false", "description": "Keep disabled for a finite response.", "disabled": true } ] }, "description": "Read logs for a workload build.\n\nSet `workload_id`, `build_id` using IDs from your own API responses." }, "response": [] }, { "id": "409e94b2-7928-575d-90df-a22cb86f2bef", "name": "Get workload logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/logs", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "logs" ], "query": [ { "key": "type", "value": "runtime", "description": "Log source.", "disabled": true }, { "key": "lines", "value": "100", "description": "Maximum requested log lines.", "disabled": true }, { "key": "follow", "value": "false", "description": "Keep disabled for a finite response.", "disabled": true } ] }, "description": "Read workload logs.\n\nSet `workload_id` using IDs from your own API responses." }, "response": [] }, { "id": "0ade2cad-459f-5d19-9aed-5aed49f8dde1", "name": "List workload replicas", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/replicas", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "replicas" ] }, "description": "Inspect workload replicas and their health.\n\nSet `workload_id` using IDs from your own API responses." }, "response": [] }, { "id": "9bcd8788-949b-55c6-8d73-7d5d77c0c86a", "name": "Get workload runtime status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/runtime-status", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "runtime-status" ] }, "description": "Inspect the current runtime state.\n\nSet `workload_id` using IDs from your own API responses." }, "response": [] }, { "id": "94aecdc4-68f9-5a5a-842c-b73426a89b1d", "name": "Get workload runtime notices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workload/{{workload_id}}/runtime-notices", "host": [ "{{base_url}}" ], "path": [ "v1", "workload", "{{workload_id}}", "runtime-notices" ] }, "description": "Inspect notices about the current workload runtime.\n\nSet `workload_id` using IDs from your own API responses." }, "response": [] } ] }, { "name": "Workspaces", "description": "Workspaces are for source-backed code workloads. Database, cache, and queue templates cannot be opened as code workspaces. File and runtime operations may hydrate source or start runtime infrastructure.", "item": [ { "id": "5f188afd-4824-5f94-b200-0b7324bbfd84", "name": "List workspaces", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of Workspace" }, "response": [ { "id": "f502edbe-cc0e-589f-ace9-de2743c4298e", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"base_build_id\": \"example\",\n \"base_source_artifact_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"name\": \"postman-example\",\n \"owner_id\": \"000000000000000000000000001\",\n \"repository_url\": \"example\",\n \"runtime_status\": \"idle\",\n \"source_manifest\": \"adios.yaml\",\n \"source_workdir\": \".\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "572b687e-ee73-516e-95f8-4f31a823d0c8", "name": "Create workspace", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"name\": \"postman-workspace\",\n \"status\": \"active\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new Workspace\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `base_build_id` | string | no | |\n| `base_source_artifact_id` | string | no | API source artifact record used to hydrate the workspace Default: `\"\"`. |\n| `branch` | string | no | Default: `\"\"`. |\n| `metadata` | object | no | |\n| `name` | string | yes | |\n| `owner_id` | string | yes | |\n| `repository_url` | string | no | Git repository URL |\n| `runtime_status` | string | no | Allowed: idle, running, stopped, failed. Default: `\"idle\"`. |\n| `source_manifest` | string | no | Project adios manifest path within the composed workspace source root Default: `\"adios.yaml\"`. |\n| `source_workdir` | string | no | Project working directory within the composed workspace source root Default: `\".\"`. |\n| `status` | string | yes | Allowed: active, archived, deleted. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `workload_id` | string | no | Default: `\"\"`. |" }, "response": [ { "id": "6a0b9635-b987-51d8-b74c-a353972777c5", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"name\": \"postman-workspace\",\n \"status\": \"active\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"base_build_id\": \"example\",\n \"base_source_artifact_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"name\": \"postman-example\",\n \"owner_id\": \"000000000000000000000000001\",\n \"repository_url\": \"example\",\n \"runtime_status\": \"idle\",\n \"source_manifest\": \"adios.yaml\",\n \"source_workdir\": \".\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "78c89978-f37a-52c1-86cb-39ebae9ab5db", "name": "Get workspace", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}" ] }, "description": "Returns a single Workspace\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [ { "id": "c1aa44bf-d2f4-5fd9-ae0b-21e179cb7de0", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"base_build_id\": \"example\",\n \"base_source_artifact_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"name\": \"postman-example\",\n \"owner_id\": \"000000000000000000000000001\",\n \"repository_url\": \"example\",\n \"runtime_status\": \"idle\",\n \"source_manifest\": \"adios.yaml\",\n \"source_workdir\": \".\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "0aaa303b-6a8f-568e-8512-b27a690d1c1c", "name": "Update workspace", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"name\": \"postman-workspace\",\n \"status\": \"active\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing Workspace\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `base_build_id` | string | no | |\n| `base_source_artifact_id` | string | no | API source artifact record used to hydrate the workspace Default: `\"\"`. |\n| `branch` | string | no | Default: `\"\"`. |\n| `metadata` | object | no | |\n| `name` | string | yes | |\n| `owner_id` | string | yes | |\n| `repository_url` | string | no | Git repository URL |\n| `runtime_status` | string | no | Allowed: idle, running, stopped, failed. Default: `\"idle\"`. |\n| `source_manifest` | string | no | Project adios manifest path within the composed workspace source root Default: `\"adios.yaml\"`. |\n| `source_workdir` | string | no | Project working directory within the composed workspace source root Default: `\".\"`. |\n| `status` | string | yes | Allowed: active, archived, deleted. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `workload_id` | string | no | Default: `\"\"`. |" }, "response": [ { "id": "a5b93409-1454-57cb-b550-bebb1253118e", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"name\": \"postman-workspace\",\n \"status\": \"active\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"base_build_id\": \"example\",\n \"base_source_artifact_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"name\": \"postman-example\",\n \"owner_id\": \"000000000000000000000000001\",\n \"repository_url\": \"example\",\n \"runtime_status\": \"idle\",\n \"source_manifest\": \"adios.yaml\",\n \"source_workdir\": \".\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "f36b4b73-9d76-58a9-8c1c-6dd2b4ba1486", "name": "Delete workspace", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}" ] }, "description": "Deletes a Workspace\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "0648aa3d-e95c-56b7-b4fa-3f7a880be26f", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "ecaad6f4-f3df-5cbd-87e1-f2a9f081f282", "name": "List workspace files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/tree?path=.", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "tree" ], "query": [ { "key": "path", "value": ".", "description": "Directory relative to the workspace root.", "disabled": false } ] }, "description": "List entries in a source-backed workspace directory.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] }, { "id": "c4130ddc-c1a5-5651-944d-4b5d2fb870fe", "name": "Read workspace file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/file?path={{file_path}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "file" ], "query": [ { "key": "path", "value": "{{file_path}}", "description": "Required workspace-relative file path.", "disabled": false } ] }, "description": "Read a file relative to the workspace root.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] }, { "id": "bc2dcf6d-73b4-5a82-a459-3a3548dc68cb", "name": "Write workspace file", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/file?path={{file_path}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "file" ], "query": [ { "key": "path", "value": "{{file_path}}", "description": "Required workspace-relative file path.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello from Postman!\\n\",\n \"encoding\": \"utf8\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create or replace the contents of the selected file.\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "cb985b10-9a5f-591e-929c-a372a976fdd1", "name": "Delete workspace file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/file?path={{file_path}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "file" ], "query": [ { "key": "path", "value": "{{file_path}}", "description": "Required workspace-relative file path.", "disabled": false } ] }, "description": "Delete the selected workspace file.\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "052e658d-95c1-53cc-8315-77980845e413", "name": "Move workspace file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/file/move", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "file", "move" ] }, "body": { "mode": "raw", "raw": "{\n \"from\": \"{{file_path}}\",\n \"to\": \"{{destination_path}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Move a file within the workspace.\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "6c7456ee-0f16-54eb-b058-009473ad6202", "name": "Run workspace lint", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/commands", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "commands" ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"lint\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Run the workspace's configured lint command. kind supports lint\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "e9bb0e42-dfbb-53b8-b976-3d0104f718df", "name": "Get workspace command status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/commands/{{command_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "commands", "{{command_id}}" ] }, "description": "Inspect a previously submitted workspace command.\n\nSet `workspace_id`, `command_id` using IDs from your own API responses." }, "response": [] }, { "id": "46f46942-4854-5f6f-b817-f67112b43150", "name": "Get workspace command logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/commands/{{command_id}}/logs", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "commands", "{{command_id}}", "logs" ] }, "description": "Read logs for a workspace command.\n\nSet `workspace_id`, `command_id` using IDs from your own API responses." }, "response": [] }, { "id": "d3b6d7a4-86b1-5168-a6f6-0734470ebf79", "name": "Get workspace runtime status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/run", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "run" ] }, "description": "Inspect the workspace preview runtime.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] }, { "id": "081afb63-8c26-534b-9ca8-11efc5092201", "name": "Start workspace preview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/run/start", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "run", "start" ] }, "description": "Start the workspace preview runtime. This may consume paid resources.\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "e656b76c-de90-55b3-872c-262264c948db", "name": "Stop workspace preview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/run/stop", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "run", "stop" ] }, "description": "Stop the workspace preview runtime.\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "992eef29-dd33-534d-a3ca-824c00e2e07e", "name": "Restart workspace preview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/run/restart", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "run", "restart" ] }, "description": "Restart the workspace preview runtime.\n\nSet `workspace_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "1cb38d55-7c0d-507d-8d7e-43aaadb9b144", "name": "Get workspace Git status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/git/status", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "git", "status" ] }, "description": "Inspect the current branch and local changes.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] }, { "id": "163e3321-e213-50a6-b2de-e1f718f8a40e", "name": "Get workspace Git history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/git/log", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "git", "log" ] }, "description": "Read recent workspace commits.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] }, { "id": "d235f938-94cf-5501-a4fa-16b30615e84f", "name": "List workspace Git branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/git/branches", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "git", "branches" ] }, "description": "List branches available in the workspace.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] }, { "id": "57938644-ec7b-5883-ac4e-8fc31cf769df", "name": "Check workspace manifest", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/manifest/check", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "manifest", "check" ] }, "description": "Validate the workspace Adios manifest.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] }, { "id": "08ef6b5a-47f6-5d91-9777-24fbc77f0d8d", "name": "Get workspace test inventory", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace/{{workspace_id}}/tests", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace", "{{workspace_id}}", "tests" ] }, "description": "Inspect detected tests and testing configuration.\n\nSet `workspace_id` using IDs from your own API responses." }, "response": [] } ] }, { "name": "Workspace sources", "description": "Manage repositories mounted into a workspace. Use identifiers returned by the API for repository references.", "item": [ { "id": "ab5b7a30-b633-5dbb-a5d5-80956689cede", "name": "List workspace sources", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace_source", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of WorkspaceSource" }, "response": [ { "id": "a0d40ddd-5637-5326-924f-ca052aae2e39", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace_source", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"000000000000000000000000001\",\n \"internal_repository_url\": \"example\",\n \"last_synced_at\": 0,\n \"metadata\": {},\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\",\n \"workspace_source_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "bb6ffdc9-6b01-568a-b960-1e01a38be793", "name": "Create workspace source", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace_source", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source" ] }, "body": { "mode": "raw", "raw": "{\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"{{internal_repository_id}}\",\n \"internal_repository_url\": \"{{internal_repository_url}}\",\n \"last_synced_at\": 0,\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"{{team_id}}\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new WorkspaceSource\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `alias` | string | yes | |\n| `branch` | string | yes | Default: `\"main\"`. |\n| `commit` | string | no | Default: `\"\"`. |\n| `external_auth_ref` | string | no | Credential reference only; secret values are never persisted here Default: `\"\"`. |\n| `external_connection_id` | string | no | Default: `\"\"`. |\n| `external_provider` | string | yes | Allowed: none, github, gitlab, bitbucket, ssh, git. Default: `\"none\"`. |\n| `external_repository_url` | string | no | Default: `\"\"`. |\n| `internal_repository_id` | string | yes | Authoritative repository in Adios Git |\n| `internal_repository_url` | string | yes | Credential-free clone URL for the authoritative Adios Git repository |\n| `last_synced_at` | integer | no | (Unix timestamp) Default: `0`. |\n| `metadata` | object | no | |\n| `mount` | string | yes | Default: `\".\"`. |\n| `repository_path` | string | yes | Default: `\".\"`. |\n| `role` | string | yes | Allowed: primary, include. Default: `\"include\"`. |\n| `source_key` | string | yes | Credential-free logical identity used to reuse one internal repository across workspaces Default: `\"\"`. |\n| `status` | string | yes | Allowed: active, archived. Default: `\"active\"`. |\n| `sync_direction` | string | yes | Allowed: none, pull, push, bidirectional. Default: `\"none\"`. |\n| `sync_error` | object | no | Default: `\"\"`. |\n| `sync_status` | string | yes | Allowed: internal_only, pending, synced, ahead, behind, diverged, error. Default: `\"internal_only\"`. |\n| `team_id` | string | yes | |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "9c288e6e-933f-5027-9886-ecde32c617b1", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace_source", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source" ] }, "body": { "mode": "raw", "raw": "{\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"{{internal_repository_id}}\",\n \"internal_repository_url\": \"{{internal_repository_url}}\",\n \"last_synced_at\": 0,\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"{{team_id}}\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"000000000000000000000000001\",\n \"internal_repository_url\": \"example\",\n \"last_synced_at\": 0,\n \"metadata\": {},\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\",\n \"workspace_source_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "3ced3e7c-b7a7-5bb5-9d6d-0c322089294d", "name": "Get workspace source", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace_source/{{workspace_source_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source", "{{workspace_source_id}}" ] }, "description": "Returns a single WorkspaceSource\n\nSet `workspace_source_id` using IDs from your own API responses." }, "response": [ { "id": "34f1dcdb-cd3c-5825-80d4-9da7dedbc12a", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace_source/{{workspace_source_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source", "{{workspace_source_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"000000000000000000000000001\",\n \"internal_repository_url\": \"example\",\n \"last_synced_at\": 0,\n \"metadata\": {},\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\",\n \"workspace_source_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "8c88857e-d63c-5e28-9f10-672290b7e5a6", "name": "Update workspace source", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace_source/{{workspace_source_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source", "{{workspace_source_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"{{internal_repository_id}}\",\n \"internal_repository_url\": \"{{internal_repository_url}}\",\n \"last_synced_at\": 0,\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"{{team_id}}\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing WorkspaceSource\n\nSet `workspace_source_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `alias` | string | yes | |\n| `branch` | string | yes | Default: `\"main\"`. |\n| `commit` | string | no | Default: `\"\"`. |\n| `external_auth_ref` | string | no | Credential reference only; secret values are never persisted here Default: `\"\"`. |\n| `external_connection_id` | string | no | Default: `\"\"`. |\n| `external_provider` | string | yes | Allowed: none, github, gitlab, bitbucket, ssh, git. Default: `\"none\"`. |\n| `external_repository_url` | string | no | Default: `\"\"`. |\n| `internal_repository_id` | string | yes | Authoritative repository in Adios Git |\n| `internal_repository_url` | string | yes | Credential-free clone URL for the authoritative Adios Git repository |\n| `last_synced_at` | integer | no | (Unix timestamp) Default: `0`. |\n| `metadata` | object | no | |\n| `mount` | string | yes | Default: `\".\"`. |\n| `repository_path` | string | yes | Default: `\".\"`. |\n| `role` | string | yes | Allowed: primary, include. Default: `\"include\"`. |\n| `source_key` | string | yes | Credential-free logical identity used to reuse one internal repository across workspaces Default: `\"\"`. |\n| `status` | string | yes | Allowed: active, archived. Default: `\"active\"`. |\n| `sync_direction` | string | yes | Allowed: none, pull, push, bidirectional. Default: `\"none\"`. |\n| `sync_error` | object | no | Default: `\"\"`. |\n| `sync_status` | string | yes | Allowed: internal_only, pending, synced, ahead, behind, diverged, error. Default: `\"internal_only\"`. |\n| `team_id` | string | yes | |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "67496fb8-d593-5597-aee1-c683cc2d230a", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workspace_source/{{workspace_source_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source", "{{workspace_source_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"{{internal_repository_id}}\",\n \"internal_repository_url\": \"{{internal_repository_url}}\",\n \"last_synced_at\": 0,\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"{{team_id}}\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"alias\": \"example\",\n \"branch\": \"main\",\n \"commit\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_auth_ref\": \"\",\n \"external_connection_id\": \"\",\n \"external_provider\": \"none\",\n \"external_repository_url\": \"\",\n \"internal_repository_id\": \"000000000000000000000000001\",\n \"internal_repository_url\": \"example\",\n \"last_synced_at\": 0,\n \"metadata\": {},\n \"mount\": \".\",\n \"repository_path\": \".\",\n \"role\": \"include\",\n \"source_key\": \"\",\n \"status\": \"active\",\n \"sync_direction\": \"none\",\n \"sync_error\": \"\",\n \"sync_status\": \"internal_only\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\",\n \"workspace_source_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "4fa978b1-8f30-57d9-9644-5669752a352a", "name": "Delete workspace source", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace_source/{{workspace_source_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source", "{{workspace_source_id}}" ] }, "description": "Deletes a WorkspaceSource\n\nSet `workspace_source_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "e062fc5c-4335-5b8f-a0fc-54764cc53fd0", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workspace_source/{{workspace_source_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workspace_source", "{{workspace_source_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] } ] }, { "name": "Source artifacts", "description": "Read source snapshot metadata used by builds and workspace hydration. Artifacts are created through source upload and build workflows.", "item": [ { "id": "27a0d5ce-a064-50f5-a364-799b7469c15d", "name": "List source artifacts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/source_artifact", "host": [ "{{base_url}}" ], "path": [ "v1", "source_artifact" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of SourceArtifact" }, "response": [ { "id": "44730544-2349-53f2-9d26-aa631834b4e1", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/source_artifact", "host": [ "{{base_url}}" ], "path": [ "v1", "source_artifact" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"branch\": \"\",\n \"build_id\": \"example\",\n \"commit_sha\": \"\",\n \"content_type\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"digest\": \"\",\n \"metadata\": {},\n \"repository_url\": \"example\",\n \"size_bytes\": 0,\n \"source_artifact_id\": \"000000000000000000000000001\",\n \"source_type\": \"unknown\",\n \"system_artifact_id\": \"example\",\n \"system_object_key\": \"\",\n \"system_uri\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "80615cc6-5ac7-552c-84ca-d7ec1632b8c4", "name": "Get source artifact", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/source_artifact/{{source_artifact_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "source_artifact", "{{source_artifact_id}}" ] }, "description": "Returns a single SourceArtifact\n\nSet `source_artifact_id` using IDs from your own API responses." }, "response": [ { "id": "5fe23821-ccbd-5efd-a7ad-21905d74ec19", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/source_artifact/{{source_artifact_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "source_artifact", "{{source_artifact_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"branch\": \"\",\n \"build_id\": \"example\",\n \"commit_sha\": \"\",\n \"content_type\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"digest\": \"\",\n \"metadata\": {},\n \"repository_url\": \"example\",\n \"size_bytes\": 0,\n \"source_artifact_id\": \"000000000000000000000000001\",\n \"source_type\": \"unknown\",\n \"system_artifact_id\": \"example\",\n \"system_object_key\": \"\",\n \"system_uri\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] } ] }, { "name": "Workflows", "description": "Manage workflow records, inspect runs, and trigger execution. The create example saves a disabled draft; configure a valid system_spec before enabling a workflow.", "item": [ { "id": "772e60f4-cf50-5cda-920f-5044a28e65cc", "name": "List workflows", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of Workflow" }, "response": [ { "id": "a90c7df2-62cf-5092-8071-1dcda81598d3", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"created_at\": 1791072000,\n \"data\": {},\n \"deleted_at\": 0,\n \"enabled\": true,\n \"owner_id\": \"000000000000000000000000001\",\n \"region\": \"\",\n \"status\": \"draft\",\n \"system_spec\": {},\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "d98409ba-9ffe-57f3-ab47-536a4865d58f", "name": "Create workflow", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workflow", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example workflow\",\n \"status\": \"draft\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new Workflow\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | object | no | Workflow designer state and API-facing metadata |\n| `enabled` | boolean | yes | Default: `true`. |\n| `owner_id` | string | no | |\n| `region` | string | no | Default: `\"\"`. |\n| `status` | string | yes | Allowed: draft, active, disabled, archived, deleted. Default: `\"draft\"`. |\n| `system_spec` | object | no | Canonical system workflow specification synced to the system backend |\n| `team_id` | string | yes | |\n| `title` | string | yes | |" }, "response": [ { "id": "1568ef83-bbca-59cb-b056-2f0892d52b3e", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workflow", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example workflow\",\n \"status\": \"draft\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"data\": {},\n \"deleted_at\": 0,\n \"enabled\": true,\n \"owner_id\": \"000000000000000000000000001\",\n \"region\": \"\",\n \"status\": \"draft\",\n \"system_spec\": {},\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "613a07fe-fbd4-529c-8476-38fc4deefd4b", "name": "Get workflow", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}" ] }, "description": "Returns a single Workflow\n\nSet `workflow_id` using IDs from your own API responses." }, "response": [ { "id": "064c4bfc-ab69-52fc-a736-55af10b8ccbf", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"data\": {},\n \"deleted_at\": 0,\n \"enabled\": true,\n \"owner_id\": \"000000000000000000000000001\",\n \"region\": \"\",\n \"status\": \"draft\",\n \"system_spec\": {},\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "ee0e33a7-4f50-5385-af2c-90a1abcc060f", "name": "Update workflow", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example workflow\",\n \"status\": \"draft\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing Workflow\n\nSet `workflow_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | object | no | Workflow designer state and API-facing metadata |\n| `enabled` | boolean | yes | Default: `true`. |\n| `owner_id` | string | no | |\n| `region` | string | no | Default: `\"\"`. |\n| `status` | string | yes | Allowed: draft, active, disabled, archived, deleted. Default: `\"draft\"`. |\n| `system_spec` | object | no | Canonical system workflow specification synced to the system backend |\n| `team_id` | string | yes | |\n| `title` | string | yes | |" }, "response": [ { "id": "722e7ff0-bcfe-5307-83e7-f37db7ef7031", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example workflow\",\n \"status\": \"draft\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"data\": {},\n \"deleted_at\": 0,\n \"enabled\": true,\n \"owner_id\": \"000000000000000000000000001\",\n \"region\": \"\",\n \"status\": \"draft\",\n \"system_spec\": {},\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "f2d71fc8-0982-55d7-84cc-dc9bee9255d1", "name": "Delete workflow", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}" ] }, "description": "Deletes a Workflow\n\nSet `workflow_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "bb7d1610-671d-54ac-8c17-47c6d3ab3486", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "623110ca-fd74-518a-873f-f47a9576f84f", "name": "List workflow runs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}/runs", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}", "runs" ] }, "description": "List runs belonging to the selected workflow.\n\nSet `workflow_id` using IDs from your own API responses." }, "response": [] }, { "id": "304402ae-ebf9-53bc-a822-370f08f18056", "name": "Run workflow", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}/runs", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}", "runs" ] }, "body": { "mode": "raw", "raw": "{\n \"payload\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Start a configured workflow. Put workflow input in payload. This may perform external actions defined by the workflow and requires a paid subscription.\n\nSet `workflow_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "42de636b-8d3b-5236-9aa7-27f815616208", "name": "Get workflow logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/workflow/{{workflow_id}}/logs", "host": [ "{{base_url}}" ], "path": [ "v1", "workflow", "{{workflow_id}}", "logs" ] }, "description": "Read workflow lifecycle logs.\n\nSet `workflow_id` using IDs from your own API responses." }, "response": [] } ] }, { "name": "Domains", "description": "Add a hostname you own, configure the verification CNAME returned by the API, then send Verify domain.", "item": [ { "id": "fd02fd5d-5d37-54d9-a25a-c1e75129ece9", "name": "List domains", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/domain", "host": [ "{{base_url}}" ], "path": [ "v1", "domain" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of Domain" }, "response": [ { "id": "336092eb-ee86-52fb-9cda-cba35dac19b1", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/domain", "host": [ "{{base_url}}" ], "path": [ "v1", "domain" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"domain_id\": \"000000000000000000000000001\",\n \"hostname\": \"app.example.com\",\n \"redirect_to\": \"example\",\n \"scope\": \"exact\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"verification_hostname\": \"example\",\n \"verification_parent_id\": \"000000000000000000000000001\",\n \"verification_value\": \"example\",\n \"verified_at\": 0,\n \"workload_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "e03557aa-75ec-5493-9ac3-377a5a756d82", "name": "Create domain", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/domain", "host": [ "{{base_url}}" ], "path": [ "v1", "domain" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new Domain\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `hostname` | string | yes | User-owned custom hostname; adios.dev and adios.run namespaces are reserved for platform-managed routes |\n| `redirect_to` | string | no | Optional URL or hostname to redirect to (e.g. https://www.adios.dev) |\n| `scope` | string | no | Authorized hostname scope: exact permits only hostname; subtree also permits descendant hostnames. New registrable domains default to subtree, new subdomains default to exact, and existing records remain subtree for backward compatibility. Allowed: exact, subtree. |\n| `status` | string | no | Domain verification status Allowed: pending, verified. Default: `\"pending\"`. |\n| `team_id` | string | yes | |\n| `verification_hostname` | string | no | DNS name that must be configured as a CNAME for ownership verification |\n| `verification_parent_id` | string | no | Verified parent domain claim from which this hostname inherited verification; empty for direct DNS verification |\n| `verification_value` | string | no | Expected CNAME value for ownership verification |\n| `verified_at` | integer | no | (Unix timestamp) Default: `0`. |\n| `workload_id` | string | no | |" }, "response": [ { "id": "83596590-4461-5d20-a467-8f8ed806b889", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/domain", "host": [ "{{base_url}}" ], "path": [ "v1", "domain" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"domain_id\": \"000000000000000000000000001\",\n \"hostname\": \"app.example.com\",\n \"redirect_to\": \"example\",\n \"scope\": \"exact\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"verification_hostname\": \"example\",\n \"verification_parent_id\": \"000000000000000000000000001\",\n \"verification_value\": \"example\",\n \"verified_at\": 0,\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "7897cee0-5660-5ec9-9324-0fb958c95333", "name": "Get domain", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/domain/{{domain_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "domain", "{{domain_id}}" ] }, "description": "Returns a single Domain\n\nSet `domain_id` using IDs from your own API responses." }, "response": [ { "id": "7ee6287d-896d-5341-afd3-db1a99148a07", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/domain/{{domain_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "domain", "{{domain_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"domain_id\": \"000000000000000000000000001\",\n \"hostname\": \"app.example.com\",\n \"redirect_to\": \"example\",\n \"scope\": \"exact\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"verification_hostname\": \"example\",\n \"verification_parent_id\": \"000000000000000000000000001\",\n \"verification_value\": \"example\",\n \"verified_at\": 0,\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "fd0469ce-1441-5fa8-ab48-91ff4154cc1b", "name": "Update domain", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/domain/{{domain_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "domain", "{{domain_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing Domain\n\nSet `domain_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `hostname` | string | yes | User-owned custom hostname; adios.dev and adios.run namespaces are reserved for platform-managed routes |\n| `redirect_to` | string | no | Optional URL or hostname to redirect to (e.g. https://www.adios.dev) |\n| `scope` | string | no | Authorized hostname scope: exact permits only hostname; subtree also permits descendant hostnames. New registrable domains default to subtree, new subdomains default to exact, and existing records remain subtree for backward compatibility. Allowed: exact, subtree. |\n| `status` | string | no | Domain verification status Allowed: pending, verified. Default: `\"pending\"`. |\n| `team_id` | string | yes | |\n| `verification_hostname` | string | no | DNS name that must be configured as a CNAME for ownership verification |\n| `verification_parent_id` | string | no | Verified parent domain claim from which this hostname inherited verification; empty for direct DNS verification |\n| `verification_value` | string | no | Expected CNAME value for ownership verification |\n| `verified_at` | integer | no | (Unix timestamp) Default: `0`. |\n| `workload_id` | string | no | |" }, "response": [ { "id": "86221500-2905-5860-9df2-b9bb63457f73", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/domain/{{domain_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "domain", "{{domain_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"domain_id\": \"000000000000000000000000001\",\n \"hostname\": \"app.example.com\",\n \"redirect_to\": \"example\",\n \"scope\": \"exact\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"verification_hostname\": \"example\",\n \"verification_parent_id\": \"000000000000000000000000001\",\n \"verification_value\": \"example\",\n \"verified_at\": 0,\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "5eff5b2c-4776-5b66-a44c-9a3e2839c367", "name": "Delete domain", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/domain/{{domain_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "domain", "{{domain_id}}" ] }, "description": "Deletes a Domain\n\nSet `domain_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "13b9edab-a02b-57dc-8f6b-4f17e5b1d46a", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/domain/{{domain_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "domain", "{{domain_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "6db56b0b-4033-5b9c-b72d-2e6238d167d4", "name": "Verify domain", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/domain/{{domain_id}}/verify", "host": [ "{{base_url}}" ], "path": [ "v1", "domain", "{{domain_id}}", "verify" ] }, "description": "Check the ownership CNAME provided when the domain was created. Configure DNS before sending this request.\n\nSet `domain_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] } ] }, { "name": "Object storage", "description": "Manage team buckets and objects. Bucket names are globally unique. Object uploads use the raw file body. Newly created S3 credentials appear in responses; keep those responses private.", "item": [ { "id": "8869ad4a-33f8-524f-b87a-5e1ba4a27dd1", "name": "List buckets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of ObjectBucket" }, "response": [ { "id": "cda925ec-6767-56d9-9255-71c118cb12ba", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"acl_policy\": {},\n \"backend_bucket\": \"example\",\n \"bucket_id\": \"000000000000000000000000001\",\n \"cache_policy\": {},\n \"canonical_hostname\": \"example\",\n \"cdn_policy\": {},\n \"config\": {},\n \"cors_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"endpoint\": \"example\",\n \"managed\": true,\n \"name\": \"postman-example\",\n \"provider\": \"adios\",\n \"public_hostname\": \"example\",\n \"public_read\": false,\n \"region\": \"default\",\n \"route_id\": \"000000000000000000000000001\",\n \"s3_path_endpoint\": \"example\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"versioning\": false\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "1d00f8ba-18a3-5279-980a-2934d397a6b9", "name": "Create bucket", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/object_bucket", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"{{bucket_name}}\",\n \"provider\": \"adios\",\n \"managed\": true,\n \"public_read\": false,\n \"versioning\": false,\n \"status\": \"pending\",\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new ObjectBucket\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `acl_policy` | object | no | Adios object ACL policy. Defaults to private with optional public prefix rules. |\n| `backend_bucket` | string | no | Provider bucket name. Defaults to the normalized object bucket name. |\n| `cache_policy` | object | no | Gateway cache policy for public object reads. |\n| `canonical_hostname` | string | no | Generated Adios bucket hostname such as bucket.s3.adios.dev. |\n| `cdn_policy` | object | no | Adios CDN policy for public object reads. Overrides cache_policy when set. |\n| `config` | object | no | Additional provider options and secret references. |\n| `cors_policy` | object | no | S3 CORS policy enforced by Adios before proxying to the object backend. |\n| `endpoint` | string | no | Optional S3-compatible endpoint override for imported buckets. |\n| `managed` | boolean | yes | Default: `true`. |\n| `name` | string | yes | Globally unique bucket namespace used for bucket.s3.adios.dev and s3.adios.dev/bucket routing. |\n| `provider` | string | yes | Allowed: adios, minio, ceph_rgw, external_s3. Default: `\"adios\"`. |\n| `public_hostname` | string | no | Optional user-owned custom hostname served through the anycast gateway for bucket access; adios.dev and adios.run namespaces are reserved. |\n| `public_read` | boolean | yes | Default: `false`. |\n| `region` | string | no | Default: `\"default\"`. |\n| `route_id` | string | no | Gateway route synced for public_hostname custom domains. |\n| `s3_path_endpoint` | string | no | Shared path-style S3 endpoint such as https://s3.adios.dev. |\n| `status` | string | yes | Allowed: pending, available, failed, deleted. Default: `\"pending\"`. |\n| `team_id` | string | yes | |\n| `versioning` | boolean | yes | Default: `false`. |" }, "response": [ { "id": "0c409ee1-c898-5d8f-a3ed-f5dacb5a60ab", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/object_bucket", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"{{bucket_name}}\",\n \"provider\": \"adios\",\n \"managed\": true,\n \"public_read\": false,\n \"versioning\": false,\n \"status\": \"pending\",\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"acl_policy\": {},\n \"backend_bucket\": \"example\",\n \"bucket_id\": \"000000000000000000000000001\",\n \"cache_policy\": {},\n \"canonical_hostname\": \"example\",\n \"cdn_policy\": {},\n \"config\": {},\n \"cors_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"endpoint\": \"example\",\n \"managed\": true,\n \"name\": \"postman-example\",\n \"provider\": \"adios\",\n \"public_hostname\": \"example\",\n \"public_read\": false,\n \"region\": \"default\",\n \"route_id\": \"000000000000000000000000001\",\n \"s3_path_endpoint\": \"example\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"versioning\": false\n}" } ] }, { "id": "c54e4822-6b06-5edb-87af-6af982d3879a", "name": "Get bucket", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}" ] }, "description": "Returns a single ObjectBucket\n\nSet `object_bucket_id` using IDs from your own API responses." }, "response": [ { "id": "90045544-384b-545a-97d3-6f1df761fee1", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"acl_policy\": {},\n \"backend_bucket\": \"example\",\n \"bucket_id\": \"000000000000000000000000001\",\n \"cache_policy\": {},\n \"canonical_hostname\": \"example\",\n \"cdn_policy\": {},\n \"config\": {},\n \"cors_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"endpoint\": \"example\",\n \"managed\": true,\n \"name\": \"postman-example\",\n \"provider\": \"adios\",\n \"public_hostname\": \"example\",\n \"public_read\": false,\n \"region\": \"default\",\n \"route_id\": \"000000000000000000000000001\",\n \"s3_path_endpoint\": \"example\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"versioning\": false\n}" } ] }, { "id": "016519a2-e9d6-5c01-9e4e-5cbc5b20741a", "name": "Update bucket", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"{{bucket_name}}\",\n \"provider\": \"adios\",\n \"managed\": true,\n \"public_read\": false,\n \"versioning\": false,\n \"status\": \"pending\",\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing ObjectBucket\n\nSet `object_bucket_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `acl_policy` | object | no | Adios object ACL policy. Defaults to private with optional public prefix rules. |\n| `backend_bucket` | string | no | Provider bucket name. Defaults to the normalized object bucket name. |\n| `cache_policy` | object | no | Gateway cache policy for public object reads. |\n| `canonical_hostname` | string | no | Generated Adios bucket hostname such as bucket.s3.adios.dev. |\n| `cdn_policy` | object | no | Adios CDN policy for public object reads. Overrides cache_policy when set. |\n| `config` | object | no | Additional provider options and secret references. |\n| `cors_policy` | object | no | S3 CORS policy enforced by Adios before proxying to the object backend. |\n| `endpoint` | string | no | Optional S3-compatible endpoint override for imported buckets. |\n| `managed` | boolean | yes | Default: `true`. |\n| `name` | string | yes | Globally unique bucket namespace used for bucket.s3.adios.dev and s3.adios.dev/bucket routing. |\n| `provider` | string | yes | Allowed: adios, minio, ceph_rgw, external_s3. Default: `\"adios\"`. |\n| `public_hostname` | string | no | Optional user-owned custom hostname served through the anycast gateway for bucket access; adios.dev and adios.run namespaces are reserved. |\n| `public_read` | boolean | yes | Default: `false`. |\n| `region` | string | no | Default: `\"default\"`. |\n| `route_id` | string | no | Gateway route synced for public_hostname custom domains. |\n| `s3_path_endpoint` | string | no | Shared path-style S3 endpoint such as https://s3.adios.dev. |\n| `status` | string | yes | Allowed: pending, available, failed, deleted. Default: `\"pending\"`. |\n| `team_id` | string | yes | |\n| `versioning` | boolean | yes | Default: `false`. |" }, "response": [ { "id": "1cd124f4-e3b1-56ad-a7a4-37b728ee31d6", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"name\": \"{{bucket_name}}\",\n \"provider\": \"adios\",\n \"managed\": true,\n \"public_read\": false,\n \"versioning\": false,\n \"status\": \"pending\",\n \"region\": \"{{region}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"acl_policy\": {},\n \"backend_bucket\": \"example\",\n \"bucket_id\": \"000000000000000000000000001\",\n \"cache_policy\": {},\n \"canonical_hostname\": \"example\",\n \"cdn_policy\": {},\n \"config\": {},\n \"cors_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"endpoint\": \"example\",\n \"managed\": true,\n \"name\": \"postman-example\",\n \"provider\": \"adios\",\n \"public_hostname\": \"example\",\n \"public_read\": false,\n \"region\": \"default\",\n \"route_id\": \"000000000000000000000000001\",\n \"s3_path_endpoint\": \"example\",\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"versioning\": false\n}" } ] }, { "id": "f631c575-b5d1-5480-b9c1-b8ad3f2aa900", "name": "Delete bucket", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}" ] }, "description": "Deletes a ObjectBucket\n\nSet `object_bucket_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "32b84f0d-e3e3-5aeb-a562-4e699028c3c9", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "b4c0fbc7-d3cb-59dc-a502-cf60717000e8", "name": "List bucket objects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/objects", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "objects" ], "query": [ { "key": "prefix", "value": "{{object_prefix}}", "description": "Object key prefix.", "disabled": true }, { "key": "limit", "value": "100", "description": "Number of entries between 1 and 5000.", "disabled": true } ] }, "description": "Browse objects under an optional prefix.\n\nSet `object_bucket_id` using IDs from your own API responses." }, "response": [] }, { "id": "be22b79a-143e-595c-b142-cac2cac8f879", "name": "Download bucket object", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/object?key={{object_key}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "object" ], "query": [ { "key": "key", "value": "{{object_key}}", "description": "Required object key.", "disabled": false } ] }, "description": "Read the raw object body. Use Postman's download option to save it.\n\nSet `object_bucket_id` using IDs from your own API responses." }, "response": [] }, { "id": "c4fa67d9-823f-5bb7-8ffb-226a694258a0", "name": "Upload bucket object", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/octet-stream" } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/object?key={{object_key}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "object" ], "query": [ { "key": "key", "value": "{{object_key}}", "description": "Required object key.", "disabled": false } ] }, "body": { "mode": "file", "file": { "src": null } }, "description": "Select a file in Body → binary before sending. The endpoint accepts raw bytes, not multipart form data; the upload limit is 5 GiB.\n\nSet `object_bucket_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "67ae436b-4c2c-5656-a58b-c491a1bb4f98", "name": "Delete bucket object", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/object?key={{object_key}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "object" ], "query": [ { "key": "key", "value": "{{object_key}}", "description": "Required object key.", "disabled": false } ] }, "description": "Delete the selected object.\n\nSet `object_bucket_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "5a89264a-e940-554b-a87c-57e1419a7934", "name": "Create bucket folder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/folders", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "folders" ] }, "body": { "mode": "raw", "raw": "{\n \"prefix\": \"{{object_prefix}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create an object folder marker.\n\nSet `object_bucket_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "97dcba63-5a16-50d8-91cc-bb75a013a164", "name": "Delete bucket folder", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/folders?prefix={{object_prefix}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "folders" ], "query": [ { "key": "prefix", "value": "{{object_prefix}}", "description": "Required folder prefix.", "disabled": false } ] }, "description": "Delete a folder and its contents.\n\nSet `object_bucket_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "8f344622-f853-56fa-90a5-ab8e8c6d53ff", "name": "List bucket access keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/access-keys", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "access-keys" ] }, "description": "List S3 key metadata for the bucket.\n\nSet `object_bucket_id` using IDs from your own API responses." }, "response": [] }, { "id": "64239d8e-c056-5b4f-b3c4-6b5f8620e339", "name": "Create bucket access key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/access-keys", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "access-keys" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"postman-example\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create S3 credentials for this bucket. Save the returned secret privately; do not publish the response.\n\nSet `object_bucket_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] }, { "id": "53641da2-51f5-5aea-a29a-99e2bfaa35b9", "name": "Delete bucket access key", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/object_bucket/{{object_bucket_id}}/access-keys/{{access_key_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "object_bucket", "{{object_bucket_id}}", "access-keys", "{{access_key_id}}" ] }, "description": "Revoke the selected S3 access key.\n\nSet `object_bucket_id`, `access_key_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] } ] }, { "name": "Gateway routes", "description": "Route a verified hostname to a workload, workflow, URL, or object bucket. Set the identifier matching target_kind.", "item": [ { "id": "97fbe278-dea1-51ce-b069-1f8259051f7a", "name": "List gateway routes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_route", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of GatewayRoute" }, "response": [ { "id": "d09c829b-9585-50f7-b4e3-0c7517e1b5f3", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_route", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"auth_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"exposure\": \"public\",\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"object_bucket_id\": \"000000000000000000000000001\",\n \"path_prefix\": \"/\",\n \"priority\": 0,\n \"rewrite_to\": \"example\",\n \"route_id\": \"000000000000000000000000001\",\n \"security_policy\": {},\n \"strip_prefix\": false,\n \"target_kind\": \"workload\",\n \"target_url\": \"example\",\n \"team_id\": \"000000000000000000000000001\",\n \"traffic_policy\": {},\n \"trigger_name\": \"example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"example\",\n \"workload_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "b673993a-065c-55e5-a388-1e6be06728c0", "name": "Create gateway route", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_route", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\",\n \"path_prefix\": \"/\",\n \"target_kind\": \"workload\",\n \"workload_id\": \"{{workload_id}}\",\n \"exposure\": \"public\",\n \"priority\": 0,\n \"strip_prefix\": false,\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new GatewayRoute\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `auth_policy` | object | no | Gateway user auth policy. This is app-facing auth, not API/admin auth. |\n| `enabled` | boolean | yes | Default: `true`. |\n| `exposure` | string | yes | Allowed: public, auth, private. Default: `\"public\"`. |\n| `geo_policy` | object | no | Optional country allow/block policy |\n| `hostname` | string | yes | |\n| `object_bucket_id` | string | no | |\n| `path_prefix` | string | yes | Default: `\"/\"`. |\n| `priority` | integer | yes | Default: `0`. |\n| `rewrite_to` | string | no | Optional rewrite path applied before proxying (for example /v1) |\n| `security_policy` | object | no | Optional route-level HTTP security override |\n| `strip_prefix` | boolean | yes | Default: `false`. |\n| `target_kind` | string | yes | Allowed: workload, workflow, url, object_storage. Default: `\"workload\"`. |\n| `target_url` | string | no | Absolute URL used when target_kind=url |\n| `team_id` | string | yes | |\n| `traffic_policy` | object | no | Optional route-level regional traffic policy for gateway target selection |\n| `trigger_name` | string | no | |\n| `workflow_id` | string | no | |\n| `workload_id` | string | no | |" }, "response": [ { "id": "f630cc6e-a5a4-57dc-ab14-823be5e207d5", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_route", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\",\n \"path_prefix\": \"/\",\n \"target_kind\": \"workload\",\n \"workload_id\": \"{{workload_id}}\",\n \"exposure\": \"public\",\n \"priority\": 0,\n \"strip_prefix\": false,\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"auth_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"exposure\": \"public\",\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"object_bucket_id\": \"000000000000000000000000001\",\n \"path_prefix\": \"/\",\n \"priority\": 0,\n \"rewrite_to\": \"example\",\n \"route_id\": \"000000000000000000000000001\",\n \"security_policy\": {},\n \"strip_prefix\": false,\n \"target_kind\": \"workload\",\n \"target_url\": \"example\",\n \"team_id\": \"000000000000000000000000001\",\n \"traffic_policy\": {},\n \"trigger_name\": \"example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"example\",\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "267db9b0-9825-5161-bea6-24738a58f7b4", "name": "Get gateway route", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_route/{{gateway_route_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route", "{{gateway_route_id}}" ] }, "description": "Returns a single GatewayRoute\n\nSet `gateway_route_id` using IDs from your own API responses." }, "response": [ { "id": "842a880a-00aa-5559-8f15-c072bca18190", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_route/{{gateway_route_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route", "{{gateway_route_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"auth_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"exposure\": \"public\",\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"object_bucket_id\": \"000000000000000000000000001\",\n \"path_prefix\": \"/\",\n \"priority\": 0,\n \"rewrite_to\": \"example\",\n \"route_id\": \"000000000000000000000000001\",\n \"security_policy\": {},\n \"strip_prefix\": false,\n \"target_kind\": \"workload\",\n \"target_url\": \"example\",\n \"team_id\": \"000000000000000000000000001\",\n \"traffic_policy\": {},\n \"trigger_name\": \"example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"example\",\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "12d2ce30-7e21-5e46-9d2a-8543ebf6172c", "name": "Update gateway route", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_route/{{gateway_route_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route", "{{gateway_route_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\",\n \"path_prefix\": \"/\",\n \"target_kind\": \"workload\",\n \"workload_id\": \"{{workload_id}}\",\n \"exposure\": \"public\",\n \"priority\": 0,\n \"strip_prefix\": false,\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing GatewayRoute\n\nSet `gateway_route_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `auth_policy` | object | no | Gateway user auth policy. This is app-facing auth, not API/admin auth. |\n| `enabled` | boolean | yes | Default: `true`. |\n| `exposure` | string | yes | Allowed: public, auth, private. Default: `\"public\"`. |\n| `geo_policy` | object | no | Optional country allow/block policy |\n| `hostname` | string | yes | |\n| `object_bucket_id` | string | no | |\n| `path_prefix` | string | yes | Default: `\"/\"`. |\n| `priority` | integer | yes | Default: `0`. |\n| `rewrite_to` | string | no | Optional rewrite path applied before proxying (for example /v1) |\n| `security_policy` | object | no | Optional route-level HTTP security override |\n| `strip_prefix` | boolean | yes | Default: `false`. |\n| `target_kind` | string | yes | Allowed: workload, workflow, url, object_storage. Default: `\"workload\"`. |\n| `target_url` | string | no | Absolute URL used when target_kind=url |\n| `team_id` | string | yes | |\n| `traffic_policy` | object | no | Optional route-level regional traffic policy for gateway target selection |\n| `trigger_name` | string | no | |\n| `workflow_id` | string | no | |\n| `workload_id` | string | no | |" }, "response": [ { "id": "4073fcb6-1af1-5532-a435-498564e55540", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_route/{{gateway_route_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route", "{{gateway_route_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"hostname\": \"{{hostname}}\",\n \"path_prefix\": \"/\",\n \"target_kind\": \"workload\",\n \"workload_id\": \"{{workload_id}}\",\n \"exposure\": \"public\",\n \"priority\": 0,\n \"strip_prefix\": false,\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"auth_policy\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"exposure\": \"public\",\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"object_bucket_id\": \"000000000000000000000000001\",\n \"path_prefix\": \"/\",\n \"priority\": 0,\n \"rewrite_to\": \"example\",\n \"route_id\": \"000000000000000000000000001\",\n \"security_policy\": {},\n \"strip_prefix\": false,\n \"target_kind\": \"workload\",\n \"target_url\": \"example\",\n \"team_id\": \"000000000000000000000000001\",\n \"traffic_policy\": {},\n \"trigger_name\": \"example\",\n \"updated_at\": 1791072000,\n \"workflow_id\": \"example\",\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "7d7c3797-d47c-5231-a078-01c110bccbb6", "name": "Delete gateway route", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_route/{{gateway_route_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route", "{{gateway_route_id}}" ] }, "description": "Deletes a GatewayRoute\n\nSet `gateway_route_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "8fca10f1-f1f2-5352-9f8d-58f0ca6a690e", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_route/{{gateway_route_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_route", "{{gateway_route_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] } ] }, { "name": "Gateway security", "description": "Configure HTTPS, CORS, and WAF settings for a hostname your team controls.", "item": [ { "id": "8f3edf9f-5390-5163-becc-47a48135de0c", "name": "List gateway security profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of GatewaySecurityProfile" }, "response": [ { "id": "ea357121-7aa7-5de3-b825-1627715d57ce", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"cors_enabled\": true,\n \"cors_headers\": \"example\",\n \"cors_methods\": \"example\",\n \"cors_origins\": \"example\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"force_https\": true,\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"profile_id\": \"000000000000000000000000001\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"waf_custom_directives\": \"example\",\n \"waf_mode\": \"off\",\n \"waf_overrides\": {},\n \"waf_rule_exclusions\": {},\n \"waf_template\": \"workload_default\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "1aa2af0a-8a60-5fcc-b070-e59d6bef03ff", "name": "Create gateway security profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile" ] }, "body": { "mode": "raw", "raw": "{\n \"cors_enabled\": true,\n \"enabled\": true,\n \"force_https\": true,\n \"hostname\": \"{{hostname}}\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"team_id\": \"{{team_id}}\",\n \"waf_mode\": \"off\",\n \"waf_template\": \"workload_default\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new GatewaySecurityProfile\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cors_enabled` | boolean | yes | Default: `true`. |\n| `cors_headers` | string | no | Comma-separated CORS request headers |\n| `cors_methods` | string | no | Comma-separated HTTP methods |\n| `cors_origins` | string | no | Comma-separated origins or * |\n| `enabled` | boolean | yes | Default: `true`. |\n| `force_https` | boolean | yes | Default: `true`. |\n| `geo_policy` | object | no | Optional host-level country allow/block policy |\n| `hostname` | string | yes | |\n| `hsts_enabled` | boolean | yes | Default: `true`. |\n| `max_body_bytes` | integer | no | Optional request body size limit. 0 means platform default. Default: `0`. |\n| `team_id` | string | yes | |\n| `waf_custom_directives` | string | no | Raw Coraza directives used when waf_template=custom |\n| `waf_mode` | string | yes | Allowed: off, monitor, block. Default: `\"off\"`. |\n| `waf_overrides` | object | no | Structured template overrides (for example per-path exclusions or rule toggles) |\n| `waf_rule_exclusions` | object | no | Optional managed exclusion list. Example: [{\"path_prefix\":\"/api/monitoring\",\"remove_rule_ids\":[920420]}] |\n| `waf_template` | string | yes | Preconfigured WAF ruleset template to apply for this host Allowed: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom. Default: `\"workload_default\"`. |" }, "response": [ { "id": "4182d97d-7f7b-5cbb-a521-cef95eab6bae", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile" ] }, "body": { "mode": "raw", "raw": "{\n \"cors_enabled\": true,\n \"enabled\": true,\n \"force_https\": true,\n \"hostname\": \"{{hostname}}\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"team_id\": \"{{team_id}}\",\n \"waf_mode\": \"off\",\n \"waf_template\": \"workload_default\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"cors_enabled\": true,\n \"cors_headers\": \"example\",\n \"cors_methods\": \"example\",\n \"cors_origins\": \"example\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"force_https\": true,\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"profile_id\": \"000000000000000000000000001\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"waf_custom_directives\": \"example\",\n \"waf_mode\": \"off\",\n \"waf_overrides\": {},\n \"waf_rule_exclusions\": {},\n \"waf_template\": \"workload_default\"\n}" } ] }, { "id": "4b418fe4-05cc-5d8e-8f35-64d8e1f60984", "name": "Get gateway security profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile/{{gateway_security_profile_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile", "{{gateway_security_profile_id}}" ] }, "description": "Returns a single GatewaySecurityProfile\n\nSet `gateway_security_profile_id` using IDs from your own API responses." }, "response": [ { "id": "f653b1bc-d377-5ba4-887c-9cf1f4908290", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile/{{gateway_security_profile_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile", "{{gateway_security_profile_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"cors_enabled\": true,\n \"cors_headers\": \"example\",\n \"cors_methods\": \"example\",\n \"cors_origins\": \"example\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"force_https\": true,\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"profile_id\": \"000000000000000000000000001\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"waf_custom_directives\": \"example\",\n \"waf_mode\": \"off\",\n \"waf_overrides\": {},\n \"waf_rule_exclusions\": {},\n \"waf_template\": \"workload_default\"\n}" } ] }, { "id": "281c57ef-2c4a-56ae-a6d9-fb348e4a4e9d", "name": "Update gateway security profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile/{{gateway_security_profile_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile", "{{gateway_security_profile_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"cors_enabled\": true,\n \"enabled\": true,\n \"force_https\": true,\n \"hostname\": \"{{hostname}}\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"team_id\": \"{{team_id}}\",\n \"waf_mode\": \"off\",\n \"waf_template\": \"workload_default\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing GatewaySecurityProfile\n\nSet `gateway_security_profile_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `cors_enabled` | boolean | yes | Default: `true`. |\n| `cors_headers` | string | no | Comma-separated CORS request headers |\n| `cors_methods` | string | no | Comma-separated HTTP methods |\n| `cors_origins` | string | no | Comma-separated origins or * |\n| `enabled` | boolean | yes | Default: `true`. |\n| `force_https` | boolean | yes | Default: `true`. |\n| `geo_policy` | object | no | Optional host-level country allow/block policy |\n| `hostname` | string | yes | |\n| `hsts_enabled` | boolean | yes | Default: `true`. |\n| `max_body_bytes` | integer | no | Optional request body size limit. 0 means platform default. Default: `0`. |\n| `team_id` | string | yes | |\n| `waf_custom_directives` | string | no | Raw Coraza directives used when waf_template=custom |\n| `waf_mode` | string | yes | Allowed: off, monitor, block. Default: `\"off\"`. |\n| `waf_overrides` | object | no | Structured template overrides (for example per-path exclusions or rule toggles) |\n| `waf_rule_exclusions` | object | no | Optional managed exclusion list. Example: [{\"path_prefix\":\"/api/monitoring\",\"remove_rule_ids\":[920420]}] |\n| `waf_template` | string | yes | Preconfigured WAF ruleset template to apply for this host Allowed: platform_default, workload_default, api_strict, nextjs, django, wordpress, custom. Default: `\"workload_default\"`. |" }, "response": [ { "id": "2d9a207b-1197-54f2-82d9-0e29ce3a6f43", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile/{{gateway_security_profile_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile", "{{gateway_security_profile_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"cors_enabled\": true,\n \"enabled\": true,\n \"force_https\": true,\n \"hostname\": \"{{hostname}}\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"team_id\": \"{{team_id}}\",\n \"waf_mode\": \"off\",\n \"waf_template\": \"workload_default\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"cors_enabled\": true,\n \"cors_headers\": \"example\",\n \"cors_methods\": \"example\",\n \"cors_origins\": \"example\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"enabled\": true,\n \"force_https\": true,\n \"geo_policy\": {},\n \"hostname\": \"app.example.com\",\n \"hsts_enabled\": true,\n \"max_body_bytes\": 0,\n \"profile_id\": \"000000000000000000000000001\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"waf_custom_directives\": \"example\",\n \"waf_mode\": \"off\",\n \"waf_overrides\": {},\n \"waf_rule_exclusions\": {},\n \"waf_template\": \"workload_default\"\n}" } ] }, { "id": "e64b13a6-8f1c-57a6-b02f-e3b991522e8d", "name": "Delete gateway security profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile/{{gateway_security_profile_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile", "{{gateway_security_profile_id}}" ] }, "description": "Deletes a GatewaySecurityProfile\n\nSet `gateway_security_profile_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "78b9556c-bb27-55b4-a5a1-124818a5a9c2", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/gateway_security_profile/{{gateway_security_profile_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "gateway_security_profile", "{{gateway_security_profile_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] } ] }, { "name": "Agent sessions", "description": "Manage conversation state. Creating a session record alone does not start an AI run. Use the Adios application or MCP integration to start agent work.", "item": [ { "id": "fded8c31-a6c8-5167-8e80-67a11a2456df", "name": "List agent sessions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of AgentSession" }, "response": [ { "id": "6e2f0bab-70b3-5296-9b5d-0e0e7eb70614", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"agent_session_id\": \"000000000000000000000000001\",\n \"channel_id\": \"\",\n \"company_project_id\": \"\",\n \"context_snapshot\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"last_message_at\": 0,\n \"memory_summary\": {},\n \"metadata\": {},\n \"mode\": \"chat\",\n \"model\": \"\",\n \"owner_id\": \"\",\n \"provider\": \"\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"thread_id\": \"\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"\",\n \"writable_repository_id\": \"\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "bc237507-33e0-585c-abde-17e09f8e1b46", "name": "Create agent session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/agent_session", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"workspace_id\": \"{{workspace_id}}\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"mode\": \"chat\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new AgentSession\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `channel_id` | string | no | Default: `\"\"`. |\n| `company_project_id` | string | no | Default: `\"\"`. |\n| `context_snapshot` | object | no | |\n| `last_message_at` | integer | no | (Unix timestamp) Default: `0`. |\n| `memory_summary` | object | no | |\n| `metadata` | object | no | |\n| `mode` | string | yes | Allowed: build, debug, ops, review, chat. Default: `\"chat\"`. |\n| `model` | string | no | Default: `\"\"`. |\n| `owner_id` | string | no | Default: `\"\"`. |\n| `provider` | string | no | Default: `\"\"`. |\n| `sharing_scope` | string | yes | Allowed: private, team. Default: `\"private\"`. |\n| `source` | string | yes | Allowed: app, slack, cli. |\n| `status` | string | yes | Allowed: active, paused, blocked, complete, failed. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `thread_id` | string | no | Default: `\"\"`. |\n| `workspace_id` | string | no | Default: `\"\"`. |\n| `writable_repository_id` | string | no | Default: `\"\"`. |" }, "response": [ { "id": "12f10170-b7fd-5843-a138-074978b7c7b7", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/agent_session", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"workspace_id\": \"{{workspace_id}}\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"mode\": \"chat\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_session_id\": \"000000000000000000000000001\",\n \"channel_id\": \"\",\n \"company_project_id\": \"\",\n \"context_snapshot\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"last_message_at\": 0,\n \"memory_summary\": {},\n \"metadata\": {},\n \"mode\": \"chat\",\n \"model\": \"\",\n \"owner_id\": \"\",\n \"provider\": \"\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"thread_id\": \"\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"\",\n \"writable_repository_id\": \"\"\n}" } ] }, { "id": "9e34545c-1639-54a4-9701-c276b6a2ddc9", "name": "Get agent session", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}" ] }, "description": "Returns a single AgentSession\n\nSet `agent_session_id` using IDs from your own API responses." }, "response": [ { "id": "e83089e6-11fb-5f34-9bc1-e6518622a86a", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_session_id\": \"000000000000000000000000001\",\n \"channel_id\": \"\",\n \"company_project_id\": \"\",\n \"context_snapshot\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"last_message_at\": 0,\n \"memory_summary\": {},\n \"metadata\": {},\n \"mode\": \"chat\",\n \"model\": \"\",\n \"owner_id\": \"\",\n \"provider\": \"\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"thread_id\": \"\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"\",\n \"writable_repository_id\": \"\"\n}" } ] }, { "id": "8dabfbf2-48d7-5676-aa53-cadc8fcf96d9", "name": "Update agent session", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"workspace_id\": \"{{workspace_id}}\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"mode\": \"chat\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing AgentSession\n\nSet `agent_session_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `channel_id` | string | no | Default: `\"\"`. |\n| `company_project_id` | string | no | Default: `\"\"`. |\n| `context_snapshot` | object | no | |\n| `last_message_at` | integer | no | (Unix timestamp) Default: `0`. |\n| `memory_summary` | object | no | |\n| `metadata` | object | no | |\n| `mode` | string | yes | Allowed: build, debug, ops, review, chat. Default: `\"chat\"`. |\n| `model` | string | no | Default: `\"\"`. |\n| `owner_id` | string | no | Default: `\"\"`. |\n| `provider` | string | no | Default: `\"\"`. |\n| `sharing_scope` | string | yes | Allowed: private, team. Default: `\"private\"`. |\n| `source` | string | yes | Allowed: app, slack, cli. |\n| `status` | string | yes | Allowed: active, paused, blocked, complete, failed. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `thread_id` | string | no | Default: `\"\"`. |\n| `workspace_id` | string | no | Default: `\"\"`. |\n| `writable_repository_id` | string | no | Default: `\"\"`. |" }, "response": [ { "id": "102419d5-877f-5740-8ca6-9ce268ff8b1b", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"{{team_id}}\",\n \"owner_id\": \"{{user_id}}\",\n \"workspace_id\": \"{{workspace_id}}\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"mode\": \"chat\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_session_id\": \"000000000000000000000000001\",\n \"channel_id\": \"\",\n \"company_project_id\": \"\",\n \"context_snapshot\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"last_message_at\": 0,\n \"memory_summary\": {},\n \"metadata\": {},\n \"mode\": \"chat\",\n \"model\": \"\",\n \"owner_id\": \"\",\n \"provider\": \"\",\n \"sharing_scope\": \"private\",\n \"source\": \"app\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"thread_id\": \"\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"\",\n \"writable_repository_id\": \"\"\n}" } ] }, { "id": "da8443a0-2bb8-5d96-928f-6dbe3728949f", "name": "Delete agent session", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}" ] }, "description": "Deletes a AgentSession\n\nSet `agent_session_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "641c0285-e06f-5258-93a7-895b6539ce43", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "80a88209-8216-59b6-a82e-f44673369fd4", "name": "Get agent session state", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}/state", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}", "state" ] }, "description": "Read the session state.\n\nSet `agent_session_id` using IDs from your own API responses." }, "response": [] }, { "id": "0c9f268c-da56-5eba-8cf1-e1bca9819c5a", "name": "Get agent session plan", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}/plan", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}", "plan" ] }, "description": "Read the session's current plan.\n\nSet `agent_session_id` using IDs from your own API responses." }, "response": [] }, { "id": "2bc72525-db33-54df-85cb-1802d0787986", "name": "Cancel agent run", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_session/{{agent_session_id}}/runs/{{agent_run_id}}/cancel", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_session", "{{agent_session_id}}", "runs", "{{agent_run_id}}", "cancel" ] }, "description": "Request cancellation of an active run in the session.\n\nSet `agent_session_id`, `agent_run_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] } ] }, { "name": "Agent runs", "description": "Inspect durable agent runs. Run state is managed by the agent service.", "item": [ { "id": "6ae7d082-e1a9-52dd-9bc1-7fa646fb7e25", "name": "List agent runs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of AgentRun" }, "response": [ { "id": "236f2074-4779-5dcb-a30d-1a79c84aeb8c", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action_digest\": \"\",\n \"agent_binding_id\": \"\",\n \"agent_binding_revision_id\": \"\",\n \"agent_definition_id\": \"\",\n \"agent_draft_id\": \"\",\n \"agent_draft_revision\": 0,\n \"agent_kit_content_digest\": \"\",\n \"agent_kit_entrypoint\": \"\",\n \"agent_kit_function\": \"\",\n \"agent_kit_version_id\": \"\",\n \"agent_run_id\": \"000000000000000000000000001\",\n \"agent_session_id\": \"\",\n \"agent_suite_id\": \"\",\n \"agent_suite_version_id\": \"\",\n \"agent_version_digest\": \"\",\n \"agent_version_id\": \"\",\n \"agent_work_cycle_id\": \"\",\n \"approval_id\": \"\",\n \"base_sha\": \"\",\n \"branch\": \"\",\n \"budget_cost_micros\": 0,\n \"budget_tokens\": 0,\n \"cached_tokens\": 0,\n \"company_project_id\": \"\",\n \"completed_at\": 0,\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"effective_policy\": {},\n \"effective_policy_digest\": \"\",\n \"environment_checkpoint_id\": \"\",\n \"error\": \"\",\n \"estimated_cost_micros\": 0,\n \"execution_id\": \"\",\n \"execution_task_id\": \"\",\n \"head_sha\": \"\",\n \"idempotency_key\": \"\",\n \"input_tokens\": 0,\n \"last_activity_at\": 0,\n \"lead_agent_run_id\": \"\",\n \"metadata\": {},\n \"mode\": \"build\",\n \"model\": \"\",\n \"output_tokens\": 0,\n \"owner_id\": \"\",\n \"parent_agent_run_id\": \"\",\n \"preset\": \"\",\n \"provider\": \"\",\n \"read_only\": false,\n \"retention_class\": \"standard\",\n \"role_key\": \"\",\n \"source\": \"app\",\n \"source_snapshot_digest\": \"\",\n \"specialist_role\": \"\",\n \"started_at\": 0,\n \"status\": \"pending\",\n \"step_count\": 0,\n \"structured_outcome\": {},\n \"suite_node_key\": \"\",\n \"suite_profile\": \"\",\n \"summary\": \"\",\n \"target_kind\": \"workspace\",\n \"target_ref\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"tool_call_count\": 0,\n \"tool_scope\": {},\n \"trace_id\": \"\",\n \"trigger_principal_id\": \"\",\n \"trigger_ref\": \"\",\n \"trigger_type\": \"manual\",\n \"updated_at\": 1791072000\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "8c894056-f2b6-5ed9-a4c4-95fbcf6b1236", "name": "Get agent run", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run/{{agent_run_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run", "{{agent_run_id}}" ] }, "description": "Returns a single AgentRun\n\nSet `agent_run_id` using IDs from your own API responses." }, "response": [ { "id": "84dfafcb-486a-5912-beaa-715a1accda6a", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run/{{agent_run_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run", "{{agent_run_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"action_digest\": \"\",\n \"agent_binding_id\": \"\",\n \"agent_binding_revision_id\": \"\",\n \"agent_definition_id\": \"\",\n \"agent_draft_id\": \"\",\n \"agent_draft_revision\": 0,\n \"agent_kit_content_digest\": \"\",\n \"agent_kit_entrypoint\": \"\",\n \"agent_kit_function\": \"\",\n \"agent_kit_version_id\": \"\",\n \"agent_run_id\": \"000000000000000000000000001\",\n \"agent_session_id\": \"\",\n \"agent_suite_id\": \"\",\n \"agent_suite_version_id\": \"\",\n \"agent_version_digest\": \"\",\n \"agent_version_id\": \"\",\n \"agent_work_cycle_id\": \"\",\n \"approval_id\": \"\",\n \"base_sha\": \"\",\n \"branch\": \"\",\n \"budget_cost_micros\": 0,\n \"budget_tokens\": 0,\n \"cached_tokens\": 0,\n \"company_project_id\": \"\",\n \"completed_at\": 0,\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"effective_policy\": {},\n \"effective_policy_digest\": \"\",\n \"environment_checkpoint_id\": \"\",\n \"error\": \"\",\n \"estimated_cost_micros\": 0,\n \"execution_id\": \"\",\n \"execution_task_id\": \"\",\n \"head_sha\": \"\",\n \"idempotency_key\": \"\",\n \"input_tokens\": 0,\n \"last_activity_at\": 0,\n \"lead_agent_run_id\": \"\",\n \"metadata\": {},\n \"mode\": \"build\",\n \"model\": \"\",\n \"output_tokens\": 0,\n \"owner_id\": \"\",\n \"parent_agent_run_id\": \"\",\n \"preset\": \"\",\n \"provider\": \"\",\n \"read_only\": false,\n \"retention_class\": \"standard\",\n \"role_key\": \"\",\n \"source\": \"app\",\n \"source_snapshot_digest\": \"\",\n \"specialist_role\": \"\",\n \"started_at\": 0,\n \"status\": \"pending\",\n \"step_count\": 0,\n \"structured_outcome\": {},\n \"suite_node_key\": \"\",\n \"suite_profile\": \"\",\n \"summary\": \"\",\n \"target_kind\": \"workspace\",\n \"target_ref\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"tool_call_count\": 0,\n \"tool_scope\": {},\n \"trace_id\": \"\",\n \"trigger_principal_id\": \"\",\n \"trigger_ref\": \"\",\n \"trigger_type\": \"manual\",\n \"updated_at\": 1791072000\n}" } ] } ] }, { "name": "Agent messages", "description": "Read authorized conversation records. Keep responses containing private code or conversations out of published examples.", "item": [ { "id": "bde20bb6-2370-5d8e-a44f-4eaaa973cf71", "name": "List agent messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_message", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_message" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of AgentMessage" }, "response": [ { "id": "6e1cc4ba-83d1-5af7-b418-3a4a3d2929b4", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_message", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_message" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"agent_message_id\": \"000000000000000000000000001\",\n \"agent_session_id\": \"000000000000000000000000001\",\n \"content\": \"\",\n \"content_json\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"role\": \"system\",\n \"sequence\": 0,\n \"team_id\": \"000000000000000000000000001\",\n \"token_count\": 0,\n \"tool_call_id\": \"\",\n \"tool_name\": \"\",\n \"updated_at\": 1791072000\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "4e6168db-7170-5e71-b61c-dce89eef2dae", "name": "Get agent message", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_message/{{agent_message_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_message", "{{agent_message_id}}" ] }, "description": "Returns a single AgentMessage\n\nSet `agent_message_id` using IDs from your own API responses." }, "response": [ { "id": "d5ade20e-ad15-51f8-9ec5-02c24c27c09a", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_message/{{agent_message_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_message", "{{agent_message_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_message_id\": \"000000000000000000000000001\",\n \"agent_session_id\": \"000000000000000000000000001\",\n \"content\": \"\",\n \"content_json\": {},\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"role\": \"system\",\n \"sequence\": 0,\n \"team_id\": \"000000000000000000000000001\",\n \"token_count\": 0,\n \"tool_call_id\": \"\",\n \"tool_name\": \"\",\n \"updated_at\": 1791072000\n}" } ] } ] }, { "name": "Agent plans", "description": "Inspect saved plans and their steps.", "item": [ { "id": "cb50ec24-6ada-533f-b5ea-981472ce75c9", "name": "List agent plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of AgentPlan" }, "response": [ { "id": "00b6b76e-c310-5b6d-961e-3aa5dc18706f", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"agent_plan_id\": \"000000000000000000000000001\",\n \"agent_run_id\": \"\",\n \"agent_session_id\": \"000000000000000000000000001\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"status\": \"pending\",\n \"summary\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Agent plan\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "a599b999-5f31-5ba0-ae14-d42e71b070bc", "name": "Get agent plan", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan/{{agent_plan_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan", "{{agent_plan_id}}" ] }, "description": "Returns a single AgentPlan\n\nSet `agent_plan_id` using IDs from your own API responses." }, "response": [ { "id": "fe53f90f-ab75-5033-adef-ae4d2b1d217b", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan/{{agent_plan_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan", "{{agent_plan_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_plan_id\": \"000000000000000000000000001\",\n \"agent_run_id\": \"\",\n \"agent_session_id\": \"000000000000000000000000001\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"metadata\": {},\n \"status\": \"pending\",\n \"summary\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Agent plan\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"\"\n}" } ] }, { "id": "8adbd395-b5ed-5492-a8fb-084f376e34e6", "name": "List agent plan steps", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan_step", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan_step" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of AgentPlanStep" }, "response": [ { "id": "d6b5ab42-1911-50fa-bbd0-28c48b3ca0b5", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan_step", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan_step" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"agent_plan_id\": \"000000000000000000000000001\",\n \"agent_plan_step_id\": \"000000000000000000000000001\",\n \"agent_version_id\": \"\",\n \"child_agent_run_id\": \"\",\n \"completed_at\": 0,\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"dependencies\": {},\n \"description\": \"\",\n \"error\": \"\",\n \"execution_task_id\": \"\",\n \"metadata\": {},\n \"position\": 0,\n \"role_key\": \"\",\n \"specialist_role\": \"\",\n \"started_at\": 0,\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"tool_name\": \"\",\n \"updated_at\": 1791072000\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "d6960131-e7d7-5f76-8d66-6f13d739c1a1", "name": "Get agent plan step", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan_step/{{agent_plan_step_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan_step", "{{agent_plan_step_id}}" ] }, "description": "Returns a single AgentPlanStep\n\nSet `agent_plan_step_id` using IDs from your own API responses." }, "response": [ { "id": "0f54b777-c54f-5926-8b44-398b86e4855f", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_plan_step/{{agent_plan_step_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_plan_step", "{{agent_plan_step_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_plan_id\": \"000000000000000000000000001\",\n \"agent_plan_step_id\": \"000000000000000000000000001\",\n \"agent_version_id\": \"\",\n \"child_agent_run_id\": \"\",\n \"completed_at\": 0,\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"dependencies\": {},\n \"description\": \"\",\n \"error\": \"\",\n \"execution_task_id\": \"\",\n \"metadata\": {},\n \"position\": 0,\n \"role_key\": \"\",\n \"specialist_role\": \"\",\n \"started_at\": 0,\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"tool_name\": \"\",\n \"updated_at\": 1791072000\n}" } ] } ] }, { "name": "Agent events", "description": "Read recorded agent events.", "item": [ { "id": "e8cfc97d-8cdf-5b6e-a3b9-1786869dfce4", "name": "List agent run events", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run_event", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run_event" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of AgentRunEvent" }, "response": [ { "id": "c1c26055-c22f-5a75-8f63-2299532d9fc7", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run_event", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run_event" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"agent_plan_id\": \"\",\n \"agent_plan_step_id\": \"\",\n \"agent_run_event_id\": \"000000000000000000000000001\",\n \"agent_run_id\": \"\",\n \"agent_session_id\": \"000000000000000000000000001\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"event_type\": \"example\",\n \"message\": \"\",\n \"payload\": {},\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "868036f7-69e7-5ec2-a9ae-1b8480b20c5f", "name": "Get agent run event", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run_event/{{agent_run_event_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run_event", "{{agent_run_event_id}}" ] }, "description": "Returns a single AgentRunEvent\n\nSet `agent_run_event_id` using IDs from your own API responses." }, "response": [ { "id": "21df64fd-eca3-503d-81ea-59fddceab176", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/agent_run_event/{{agent_run_event_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "agent_run_event", "{{agent_run_event_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_plan_id\": \"\",\n \"agent_plan_step_id\": \"\",\n \"agent_run_event_id\": \"000000000000000000000000001\",\n \"agent_run_id\": \"\",\n \"agent_session_id\": \"000000000000000000000000001\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"event_type\": \"example\",\n \"message\": \"\",\n \"payload\": {},\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000\n}" } ] } ] }, { "name": "Feature planning", "description": "Manage feature trees, nodes, and assignments. Use related IDs from your own workspace.", "item": [ { "id": "3194a3b7-621a-5e35-a3d3-1926a52554d6", "name": "List feature trees", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_tree", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of FeatureTree" }, "response": [ { "id": "2d305089-58ae-575a-a367-28d8ad756e86", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_tree", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature tree\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "2cfe784e-8300-5d81-a148-13be17f29912", "name": "Create feature tree", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_tree", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature tree\",\n \"workload_id\": \"\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new FeatureTree\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `metadata` | object | no | |\n| `status` | string | yes | Allowed: active, archived, deleted. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `title` | string | yes | Default: `\"Feature tree\"`. |\n| `workload_id` | string | no | Default: `\"\"`. |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "c1b69010-ddd1-558e-93c4-5380471f9d90", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_tree", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature tree\",\n \"workload_id\": \"\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature tree\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "a9147e45-476e-5315-b8ca-3943646f6200", "name": "Get feature tree", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_tree/{{feature_tree_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree", "{{feature_tree_id}}" ] }, "description": "Returns a single FeatureTree\n\nSet `feature_tree_id` using IDs from your own API responses." }, "response": [ { "id": "138ec29e-5ecf-5890-b214-d697c944bbe7", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_tree/{{feature_tree_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree", "{{feature_tree_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature tree\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "03bf594a-6521-5bd9-8b52-b7282e3ea520", "name": "Update feature tree", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_tree/{{feature_tree_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree", "{{feature_tree_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature tree\",\n \"workload_id\": \"\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing FeatureTree\n\nSet `feature_tree_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `metadata` | object | no | |\n| `status` | string | yes | Allowed: active, archived, deleted. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `title` | string | yes | Default: `\"Feature tree\"`. |\n| `workload_id` | string | no | Default: `\"\"`. |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "61a86623-ed84-57e7-91b0-04b4d373c981", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_tree/{{feature_tree_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree", "{{feature_tree_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature tree\",\n \"workload_id\": \"\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature tree\",\n \"updated_at\": 1791072000,\n \"workload_id\": \"\",\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "c8cde32b-5c9a-504d-bb7d-74c0ecf0352e", "name": "Delete feature tree", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_tree/{{feature_tree_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree", "{{feature_tree_id}}" ] }, "description": "Deletes a FeatureTree\n\nSet `feature_tree_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "0e7096ab-57e2-59e4-bb81-54a09ecc1f7f", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_tree/{{feature_tree_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_tree", "{{feature_tree_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "71fdcce0-6855-52f3-a144-83ee7dc2e2e5", "name": "List feature nodes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_node", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of FeatureNode" }, "response": [ { "id": "1f43b5d5-0ee8-52a8-b601-d7bd19550d5d", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_node", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"feature_node_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "42331ab3-4356-5906-88b9-cb9dc3c6142a", "name": "Create feature node", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_node", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node" ] }, "body": { "mode": "raw", "raw": "{\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"description\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new FeatureNode\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `category` | string | yes | Allowed: auth, bill, billing, security, complex, complexity, refactor, ops, ui, other. Default: `\"other\"`. |\n| `complexity` | string | yes | Allowed: low, medium, high, complex. Default: `\"medium\"`. |\n| `description` | object | no | Default: `\"\"`. |\n| `feature_tree_id` | string | yes | |\n| `metadata` | object | no | |\n| `parent_feature_node_id` | string | no | Default: `\"\"`. |\n| `position` | integer | no | Default: `0`. |\n| `status` | string | yes | Allowed: pending, running, blocked, complete, failed, skipped. Default: `\"pending\"`. |\n| `team_id` | string | yes | |\n| `title` | string | yes | |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "a02c9a0a-0fdb-5f49-8e56-667193457fef", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_node", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node" ] }, "body": { "mode": "raw", "raw": "{\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"description\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"feature_node_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "7a3a948d-3340-56e8-98d0-8da1f29df035", "name": "Get feature node", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_node/{{feature_node_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node", "{{feature_node_id}}" ] }, "description": "Returns a single FeatureNode\n\nSet `feature_node_id` using IDs from your own API responses." }, "response": [ { "id": "7bf06d2d-9062-5b4f-a6f1-d000a4533741", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_node/{{feature_node_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node", "{{feature_node_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"feature_node_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "5dc41125-8df5-5d3e-af71-a331a527324b", "name": "Update feature node", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_node/{{feature_node_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node", "{{feature_node_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"description\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing FeatureNode\n\nSet `feature_node_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `category` | string | yes | Allowed: auth, bill, billing, security, complex, complexity, refactor, ops, ui, other. Default: `\"other\"`. |\n| `complexity` | string | yes | Allowed: low, medium, high, complex. Default: `\"medium\"`. |\n| `description` | object | no | Default: `\"\"`. |\n| `feature_tree_id` | string | yes | |\n| `metadata` | object | no | |\n| `parent_feature_node_id` | string | no | Default: `\"\"`. |\n| `position` | integer | no | Default: `0`. |\n| `status` | string | yes | Allowed: pending, running, blocked, complete, failed, skipped. Default: `\"pending\"`. |\n| `team_id` | string | yes | |\n| `title` | string | yes | |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "244ac851-29db-5909-bcbf-e87bfef5e1a2", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_node/{{feature_node_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node", "{{feature_node_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"description\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Postman example\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"category\": \"other\",\n \"complexity\": \"medium\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"description\": \"\",\n \"feature_node_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"parent_feature_node_id\": \"\",\n \"position\": 0,\n \"status\": \"pending\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Postman example\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "48e2df04-0e74-52cb-b832-f8669dba0471", "name": "Delete feature node", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_node/{{feature_node_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node", "{{feature_node_id}}" ] }, "description": "Deletes a FeatureNode\n\nSet `feature_node_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "b0425187-7a59-5487-bb6d-5b86f97aacab", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_node/{{feature_node_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_node", "{{feature_node_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] }, { "id": "9ed8c4c2-f11b-56ca-9387-98b1ac5f0b5a", "name": "List feature assignments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_assignment", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of FeatureAssignment" }, "response": [ { "id": "66ed0912-8e31-51ec-8c41-878914934f04", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_assignment", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_assignment_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"selected_node_ids\": {},\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature assignment\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "d6b7e2d3-eecf-5ae2-9bd8-9f86a52444ef", "name": "Create feature assignment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_assignment", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment" ] }, "body": { "mode": "raw", "raw": "{\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature assignment\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new FeatureAssignment\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `agent_plan_id` | string | no | Default: `\"\"`. |\n| `agent_session_id` | string | no | Default: `\"\"`. |\n| `branch` | string | no | Default: `\"\"`. |\n| `feature_tree_id` | string | yes | |\n| `metadata` | object | no | |\n| `selected_node_ids` | object | no | |\n| `status` | string | yes | Allowed: queued, running, blocked, complete, failed, cancelled. Default: `\"queued\"`. |\n| `target_type` | string | yes | Allowed: new_workspace, existing_workspace, git_branch. Default: `\"new_workspace\"`. |\n| `target_workspace_id` | string | no | Default: `\"\"`. |\n| `team_id` | string | yes | |\n| `title` | string | yes | Default: `\"Feature assignment\"`. |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "ae2b58f7-d0dd-5fd6-90b1-ed6875b68c71", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_assignment", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment" ] }, "body": { "mode": "raw", "raw": "{\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature assignment\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_assignment_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"selected_node_ids\": {},\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature assignment\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "6def3ddb-7797-5b71-a1a4-4f5ed1bdb8fa", "name": "Get feature assignment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_assignment/{{feature_assignment_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment", "{{feature_assignment_id}}" ] }, "description": "Returns a single FeatureAssignment\n\nSet `feature_assignment_id` using IDs from your own API responses." }, "response": [ { "id": "c442d11b-545f-5482-be3d-f378dfb6e6e3", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_assignment/{{feature_assignment_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment", "{{feature_assignment_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_assignment_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"selected_node_ids\": {},\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature assignment\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "7bf95d6a-4fd2-5286-8329-658185ce527d", "name": "Update feature assignment", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_assignment/{{feature_assignment_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment", "{{feature_assignment_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature assignment\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing FeatureAssignment\n\nSet `feature_assignment_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `agent_plan_id` | string | no | Default: `\"\"`. |\n| `agent_session_id` | string | no | Default: `\"\"`. |\n| `branch` | string | no | Default: `\"\"`. |\n| `feature_tree_id` | string | yes | |\n| `metadata` | object | no | |\n| `selected_node_ids` | object | no | |\n| `status` | string | yes | Allowed: queued, running, blocked, complete, failed, cancelled. Default: `\"queued\"`. |\n| `target_type` | string | yes | Allowed: new_workspace, existing_workspace, git_branch. Default: `\"new_workspace\"`. |\n| `target_workspace_id` | string | no | Default: `\"\"`. |\n| `team_id` | string | yes | |\n| `title` | string | yes | Default: `\"Feature assignment\"`. |\n| `workspace_id` | string | yes | |" }, "response": [ { "id": "c81d92c9-3384-5e63-8101-5dc615c604c8", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/feature_assignment/{{feature_assignment_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment", "{{feature_assignment_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"feature_tree_id\": \"{{feature_tree_id}}\",\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"{{team_id}}\",\n \"title\": \"Feature assignment\",\n \"workspace_id\": \"{{workspace_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"agent_plan_id\": \"\",\n \"agent_session_id\": \"\",\n \"branch\": \"\",\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"feature_assignment_id\": \"000000000000000000000000001\",\n \"feature_tree_id\": \"000000000000000000000000001\",\n \"metadata\": {},\n \"selected_node_ids\": {},\n \"status\": \"queued\",\n \"target_type\": \"new_workspace\",\n \"target_workspace_id\": \"\",\n \"team_id\": \"000000000000000000000000001\",\n \"title\": \"Feature assignment\",\n \"updated_at\": 1791072000,\n \"workspace_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "38e0a4f8-8963-5395-a1ff-456f64c680a6", "name": "Delete feature assignment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_assignment/{{feature_assignment_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment", "{{feature_assignment_id}}" ] }, "description": "Deletes a FeatureAssignment\n\nSet `feature_assignment_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "2e3fedf9-351e-59a6-a3d9-959b4e42c57d", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/feature_assignment/{{feature_assignment_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "feature_assignment", "{{feature_assignment_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] } ] }, { "name": "Webhooks", "description": "Manage workload webhook configuration. Provider callback delivery is outside this collection.", "item": [ { "id": "d48d4312-d563-5ade-ab71-117b70d7f0ac", "name": "List webhooks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/webhook", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] }, "description": "Returns a paginated list of Webhook" }, "response": [ { "id": "bcfdd371-62da-51ca-bf2f-bf371d7bf7a2", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/webhook", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "per_page", "value": "20", "description": "Items per page", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_id\": \"example\",\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"webhook_id\": \"000000000000000000000000001\",\n \"workload_id\": \"000000000000000000000000001\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 1,\n \"total\": 1\n }\n}" } ] }, { "id": "22c39cff-57ea-56f8-a92f-de78c0cf2c73", "name": "Create webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/webhook", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook" ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new Webhook\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `external_id` | string | no | External ID from the provider (e.g. hook ID) |\n| `provider` | string | yes | Allowed: github, bitbucket. |\n| `status` | string | yes | Allowed: active, inactive. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `workload_id` | string | yes | |" }, "response": [ { "id": "e74152f5-bf6c-5215-b87d-2318d03dd402", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/webhook", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook" ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_id\": \"example\",\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"webhook_id\": \"000000000000000000000000001\",\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "43a70ee8-e465-5b22-a2b3-b446b5b8dfce", "name": "Get webhook", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/webhook/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook", "{{webhook_id}}" ] }, "description": "Returns a single Webhook\n\nSet `webhook_id` using IDs from your own API responses." }, "response": [ { "id": "34b0f81e-8c94-5ff8-8e75-7b0baf314818", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/webhook/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook", "{{webhook_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_id\": \"example\",\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"webhook_id\": \"000000000000000000000000001\",\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "3b5bba34-6bb7-5c25-a78a-e64ef60edc1c", "name": "Update webhook", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/webhook/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook", "{{webhook_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing Webhook\n\nSet `webhook_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it.\n\nRequest fields (the body contains an editable example):\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `external_id` | string | no | External ID from the provider (e.g. hook ID) |\n| `provider` | string | yes | Allowed: github, bitbucket. |\n| `status` | string | yes | Allowed: active, inactive. Default: `\"active\"`. |\n| `team_id` | string | yes | |\n| `workload_id` | string | yes | |" }, "response": [ { "id": "7c9b315e-db37-5796-b2ba-c9caf6db0cf7", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/webhook/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook", "{{webhook_id}}" ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"{{team_id}}\",\n \"workload_id\": \"{{workload_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created_at\": 1791072000,\n \"deleted_at\": 0,\n \"external_id\": \"example\",\n \"provider\": \"github\",\n \"status\": \"active\",\n \"team_id\": \"000000000000000000000000001\",\n \"updated_at\": 1791072000,\n \"webhook_id\": \"000000000000000000000000001\",\n \"workload_id\": \"000000000000000000000000001\"\n}" } ] }, { "id": "3b6c09e4-f428-57bb-95bf-59b6e485bb12", "name": "Delete webhook", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/webhook/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook", "{{webhook_id}}" ] }, "description": "Deletes a Webhook\n\nSet `webhook_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [ { "id": "11b5d0e1-4238-51b5-aa5c-08d68dd83735", "name": "Illustrative success (not a live response)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/webhook/{{webhook_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "webhook", "{{webhook_id}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Deleted successfully\"\n}" } ] } ] }, { "name": "Billing", "description": "Inspect plans, subscription state, resource use, and managed AI usage.", "item": [ { "id": "50e454da-66c1-5e93-9fb8-64a56503ec38", "name": "List billing plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/team/billing/plans", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "billing", "plans" ] }, "auth": { "type": "noauth" }, "description": "Read the public plan catalog." }, "response": [] }, { "id": "be9a6252-2251-577b-9568-8695db1dfe6f", "name": "Get subscription", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/billing/subscription", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "billing", "subscription" ] }, "description": "Read the selected team's subscription." }, "response": [] }, { "id": "9184a72a-9d07-5077-91f0-5901ebcb99f9", "name": "Get resource usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/billing/resources", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "billing", "resources" ] }, "description": "Read the selected team's resource usage." }, "response": [] }, { "id": "f860c3d1-8c82-54b4-8570-d59468274d74", "name": "Get AI usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/billing/ai-usage", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "billing", "ai-usage" ] }, "description": "Read the selected team's managed AI token usage." }, "response": [] }, { "id": "74505de3-2423-5cd7-a57d-125933413b34", "name": "List AI token packs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/team/billing/token-packs", "host": [ "{{base_url}}" ], "path": [ "v1", "team", "billing", "token-packs" ] }, "description": "Read the selected team's token packs." }, "response": [] } ] }, { "name": "AI models", "description": "Inspect available models and your AI configuration.", "item": [ { "id": "7abb14c7-c793-5f36-98c2-725c25c1c8a2", "name": "List AI models", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/ai/catalog", "host": [ "{{base_url}}" ], "path": [ "v1", "ai", "catalog" ] }, "description": "Inspect the available model catalog." }, "response": [] }, { "id": "48caef34-c1ea-568d-a511-20c89b449123", "name": "Get AI settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/ai/settings", "host": [ "{{base_url}}" ], "path": [ "v1", "ai", "settings" ] }, "description": "Read the selected team's AI provider configuration." }, "response": [] } ] }, { "name": "Integrations", "description": "Inspect authorized OAuth clients and revoke a connection when needed.", "item": [ { "id": "9a810ffe-9cd9-55b8-898f-899514f178bd", "name": "List authorized OAuth clients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/oauth/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "oauth", "clients" ] }, "description": "List your authorized MCP client connections." }, "response": [] }, { "id": "cb13aa95-240e-5c35-a4a4-9d7165eb3ed1", "name": "Disconnect OAuth client", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Tenant-ID", "value": "{{team_id}}", "description": "Active team ID. Must match the tenant bound to a diagnostic token." } ], "url": { "raw": "{{base_url}}/v1/oauth/clients/{{oauth_client_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "oauth", "clients", "{{oauth_client_id}}" ] }, "description": "Revoke the selected authorized client connection.\n\nSet `oauth_client_id` using IDs from your own API responses.\n\nThis request changes data or starts an action. Review the target and body before sending it." }, "response": [] } ] } ], "variable": [ { "key": "base_url", "value": "https://api.adios.dev", "type": "string", "description": "API origin without a trailing slash; paths already include /v1." }, { "key": "access_token", "value": "", "type": "string", "description": "Private bearer token. Team admins can use adios auth print-token --ttl 15m after adios login. Never share this value." }, { "key": "team_id", "value": "", "type": "string", "description": "Active CLI team ID, sent as X-Tenant-ID. Use adios teams to inspect teams." }, { "key": "access_key_id", "value": "", "type": "string", "description": "Set access_key_id from a resource returned by the API." }, { "key": "agent_message_id", "value": "", "type": "string", "description": "Set agent_message_id from a resource returned by the API." }, { "key": "agent_plan_id", "value": "", "type": "string", "description": "Set agent_plan_id from a resource returned by the API." }, { "key": "agent_plan_step_id", "value": "", "type": "string", "description": "Set agent_plan_step_id from a resource returned by the API." }, { "key": "agent_run_event_id", "value": "", "type": "string", "description": "Set agent_run_event_id from a resource returned by the API." }, { "key": "agent_run_id", "value": "", "type": "string", "description": "Set agent_run_id from a resource returned by the API." }, { "key": "agent_session_id", "value": "", "type": "string", "description": "Set agent_session_id from a resource returned by the API." }, { "key": "bucket_name", "value": "", "type": "string", "description": "A globally unique bucket name, 3–63 characters." }, { "key": "build_id", "value": "", "type": "string", "description": "Set build_id from a resource returned by the API." }, { "key": "command_id", "value": "", "type": "string", "description": "Set command_id from a resource returned by the API." }, { "key": "destination_path", "value": "postman-example-moved.txt", "type": "string", "description": "Destination path relative to the workspace root." }, { "key": "domain_id", "value": "", "type": "string", "description": "Set domain_id from a resource returned by the API." }, { "key": "feature_assignment_id", "value": "", "type": "string", "description": "Set feature_assignment_id from a resource returned by the API." }, { "key": "feature_node_id", "value": "", "type": "string", "description": "Set feature_node_id from a resource returned by the API." }, { "key": "feature_tree_id", "value": "", "type": "string", "description": "Set feature_tree_id from a resource returned by the API." }, { "key": "file_path", "value": "postman-example.txt", "type": "string", "description": "Path relative to the workspace root." }, { "key": "gateway_route_id", "value": "", "type": "string", "description": "Set gateway_route_id from a resource returned by the API." }, { "key": "gateway_security_profile_id", "value": "", "type": "string", "description": "Set gateway_security_profile_id from a resource returned by the API." }, { "key": "hostname", "value": "", "type": "string", "description": "A custom hostname you own and can verify through DNS." }, { "key": "internal_repository_id", "value": "", "type": "string", "description": "Set internal_repository_id from a resource returned by the API." }, { "key": "internal_repository_url", "value": "", "type": "string", "description": "Set internal_repository_url from a resource returned by the API." }, { "key": "invitation_id", "value": "", "type": "string", "description": "Set invitation_id from a resource returned by the API." }, { "key": "invite_email", "value": "", "type": "string", "description": "Email address of the person you intend to invite." }, { "key": "oauth_client_id", "value": "", "type": "string", "description": "Set oauth_client_id from a resource returned by the API." }, { "key": "object_bucket_id", "value": "", "type": "string", "description": "Set object_bucket_id from a resource returned by the API." }, { "key": "object_key", "value": "postman/example.txt", "type": "string", "description": "Object key within the selected bucket." }, { "key": "object_prefix", "value": "postman/", "type": "string", "description": "Object folder prefix." }, { "key": "region", "value": "", "type": "string", "description": "Choose an available region returned by Get deployment context." }, { "key": "repository_url", "value": "", "type": "string", "description": "Git repository URL accessible to your team." }, { "key": "source_artifact_id", "value": "", "type": "string", "description": "Set source_artifact_id from a resource returned by the API." }, { "key": "user_id", "value": "", "type": "string", "description": "Your user ID; Get current user saves it in the selected environment." }, { "key": "webhook_id", "value": "", "type": "string", "description": "Set webhook_id from a resource returned by the API." }, { "key": "workflow_id", "value": "", "type": "string", "description": "Set workflow_id from a resource returned by the API." }, { "key": "workload_id", "value": "", "type": "string", "description": "Set workload_id from a resource returned by the API." }, { "key": "workload_image", "value": "", "type": "string", "description": "Image or rootfs supported by your workload deployment configuration." }, { "key": "workspace_id", "value": "", "type": "string", "description": "Set workspace_id from a resource returned by the API." }, { "key": "workspace_source_id", "value": "", "type": "string", "description": "Set workspace_source_id from a resource returned by the API." } ] }