{ "opencollection": "1.0.0", "info": { "name": "QuantCDN API", "version": "4.15.8" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "CrawlerSchedules", "type": "folder" }, "items": [ { "info": { "name": "List schedules for a crawler", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/schedules", "params": [ { "name": "organization", "value": "test-org", "type": "path" }, { "name": "project", "value": "test-project", "type": "path" }, { "name": "crawler", "value": "00000000-0000-0000-0000-000000000000", "type": "path" } ] }, "docs": "List schedules for a crawler" }, { "info": { "name": "Add a new schedule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/schedules", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "", "type": "path", "description": "Crawler identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new schedule" }, { "info": { "name": "Show a specific schedule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/schedules/:crawler_schedule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "", "type": "path", "description": "Crawler identifier" }, { "name": "crawler_schedule", "value": "", "type": "path", "description": "Crawler schedule identifier" } ] }, "docs": "Show a specific schedule" }, { "info": { "name": "Edit a schedule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/schedules/:crawler_schedule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "", "type": "path", "description": "Crawler identifier" }, { "name": "crawler_schedule", "value": "", "type": "path", "description": "Crawler schedule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a schedule" }, { "info": { "name": "Delete a schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/schedules/:crawler_schedule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "", "type": "path", "description": "Crawler identifier" }, { "name": "crawler_schedule", "value": "", "type": "path", "description": "Crawler schedule identifier" } ] }, "docs": "Delete a schedule" } ] }, { "info": { "name": "Crawlers", "type": "folder" }, "items": [ { "info": { "name": "List crawlers for the project", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ] }, "docs": "List crawlers for the project" }, { "info": { "name": "Create a new crawler", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new crawler" }, { "info": { "name": "Get details of a single crawler", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The UUID of the crawler" } ] }, "docs": "Get details of a single crawler" }, { "info": { "name": "Update a crawler", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The UUID of the crawler" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a crawler" }, { "info": { "name": "Delete a crawler", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "The UUID of the crawler" } ] }, "docs": "Delete a crawler" }, { "info": { "name": "Run a crawler", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/run", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Crawler identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run a crawler" }, { "info": { "name": "Get all runs for a crawler", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/runs", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Crawler identifier" } ] }, "docs": "Get all runs for a crawler" }, { "info": { "name": "Get a run by ID", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/crawlers/:crawler/runs/:run_id", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "crawler", "value": "00000000-0000-0000-0000-000000000000", "type": "path", "description": "Crawler identifier" }, { "name": "run_id", "value": "1", "type": "path", "description": "Run identifier" } ] }, "docs": "Get a run by ID" } ] }, { "info": { "name": "Headers", "type": "folder" }, "items": [ { "info": { "name": "List custom headers for a project", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/custom-headers", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ] }, "docs": "List custom headers for a project" }, { "info": { "name": "Create or update custom headers", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/custom-headers", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update custom headers" }, { "info": { "name": "Delete custom headers", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/custom-headers", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete custom headers" } ] }, { "info": { "name": "Domains", "type": "folder" }, "items": [ { "info": { "name": "List all domains for a project", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/domains", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ] }, "docs": "List all domains for a project" }, { "info": { "name": "Add a new domain", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/domains", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new domain" }, { "info": { "name": "Get details of a single domain", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/domains/:domain", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "domain", "value": "0000", "type": "path", "description": "Domain id" } ] }, "docs": "Get details of a single domain" }, { "info": { "name": "Delete a domain", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/domains/:domain", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "domain", "value": "0000", "type": "path", "description": "Domain id" } ] }, "docs": "Delete a domain" }, { "info": { "name": "Renew the SSL certificate for a domain", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/domains/:domain/renew", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "domain", "value": "0000", "type": "path", "description": "Domain id" } ] }, "docs": "Renew the SSL certificate for a domain" } ] }, { "info": { "name": "KV", "type": "folder" }, "items": [ { "info": { "name": "List key-value stores", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ] }, "docs": "List key-value stores" }, { "info": { "name": "Add a kv store", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a kv store" }, { "info": { "name": "Get a kv store", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "0000", "type": "path" } ] }, "docs": "Get a kv store" }, { "info": { "name": "Delete a kv store", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "0000", "type": "path" } ] }, "docs": "Delete a kv store" }, { "info": { "name": "Link a KV store to another project", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id/link", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Source project identifier" }, { "name": "store_id", "value": "store-123", "type": "path", "description": "KV store identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Share a KV store from the source project with a target project. The store will be accessible in the target project." }, { "info": { "name": "Unlink a KV store from this project", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id/link", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "store-123", "type": "path", "description": "KV store identifier" } ] }, "docs": "Remove access to a linked KV store from this project. The store must be linked (not owned by this project)." }, { "info": { "name": "List items in a kv store", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id/items", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "0000", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Number of items to return" }, { "name": "search", "value": "", "type": "query", "description": "Search filter for keys" }, { "name": "include_values", "value": "", "type": "query", "description": "Include values in the response. Secret values will be redacted as '[ENCRYPTED]' for security." } ] }, "docs": "List items in a kv store" }, { "info": { "name": "Add an item to a kv store", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id/items", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "0000", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an item to a kv store" }, { "info": { "name": "Get an item from a kv store", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id/items/:key", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "0000", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as '[ENCRYPTED]' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction." }, { "info": { "name": "Update an item in a kv store", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id/items/:key", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "0000", "type": "path" }, { "name": "key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an item in a kv store" }, { "info": { "name": "Delete an item from a kv store", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/kv/:store_id/items/:key", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "store_id", "value": "0000", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "Delete an item from a kv store" } ] }, { "info": { "name": "CDN Metrics", "type": "folder" }, "items": [ { "info": { "name": "Get hourly metrics", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/v2/organizations/:organization/projects/:project/metrics/hourly", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "domain", "value": "", "type": "query", "description": "Filter by domain ID or domain name" }, { "name": "metrics[]", "value": "", "type": "query", "description": "Metrics to return (default: hits, bytes). Use the /metrics/available endpoint to list all metrics by category." }, { "name": "timestamp_format", "value": "", "type": "query", "description": "Timestamp format in response" } ] }, "docs": "Returns the last hour of minute-by-minute metrics data" }, { "info": { "name": "Get daily metrics", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/v2/organizations/:organization/projects/:project/metrics/daily", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "domain", "value": "", "type": "query", "description": "Filter by domain ID or domain name" }, { "name": "metrics[]", "value": "", "type": "query", "description": "Metrics to return (default: hits, bytes). Use the /metrics/available endpoint to list all metrics by category." }, { "name": "timestamp_format", "value": "", "type": "query", "description": "Timestamp format in response" } ] }, "docs": "Returns the last 30 days of daily metrics data" }, { "info": { "name": "Get monthly metrics", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/v2/organizations/:organization/projects/:project/metrics/monthly", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "domain", "value": "", "type": "query", "description": "Filter by domain ID or domain name" }, { "name": "metrics[]", "value": "", "type": "query", "description": "Metrics to return (default: hits, bytes). Use the /metrics/available endpoint to list all metrics by category." }, { "name": "timestamp_format", "value": "", "type": "query", "description": "Timestamp format in response" } ] }, "docs": "Returns the last 12 months of monthly metrics data" } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all organizations", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations" }, "docs": "Retrieve all organizations" }, { "info": { "name": "Get details of a single organization", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" } ] }, "docs": "Get details of a single organization" } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all projects for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" } ] }, "docs": "Retrieve all projects for an organization" }, { "info": { "name": "Create a new project", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new project" }, { "info": { "name": "Get details of a single project", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" }, { "name": "with_token", "value": "", "type": "query" } ] }, "docs": "Get details of a single project" }, { "info": { "name": "Update a project", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a project" }, { "info": { "name": "Delete a project", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ] }, "docs": "Delete a project" } ] }, { "info": { "name": "Purge", "type": "folder" }, "items": [ { "info": { "name": "Purge cache via URL or cache keys", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/purge", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "test-project", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Purge cache via URL or cache keys" } ] }, { "info": { "name": "Rules", "type": "folder" }, "items": [ { "info": { "name": "List authentication rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/auth", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ] }, "docs": "List authentication rules" }, { "info": { "name": "Create an authentication rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/auth", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an authentication rule" }, { "info": { "name": "Get details of an authentication rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/auth/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Get details of an authentication rule" }, { "info": { "name": "Update an authentication rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/auth/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an authentication rule" }, { "info": { "name": "Delete an authentication rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/auth/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Delete an authentication rule" }, { "info": { "name": "List bot challenge rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/bot-challenge", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ] }, "docs": "List bot challenge rules" }, { "info": { "name": "Create a bot challenge rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/bot-challenge", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a bot challenge rule" }, { "info": { "name": "Get details of a bot challenge rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/bot-challenge/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Get details of a bot challenge rule" }, { "info": { "name": "Update a bot challenge rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/bot-challenge/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a bot challenge rule" }, { "info": { "name": "Delete a bot challenge rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/bot-challenge/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Delete a bot challenge rule" }, { "info": { "name": "List content filter rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/content-filter", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ] }, "docs": "List content filter rules" }, { "info": { "name": "Create a content filter rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/content-filter", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a content filter rule" }, { "info": { "name": "Get details of a content filter rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/content-filter/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Get details of a content filter rule" }, { "info": { "name": "Update a content filter rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/content-filter/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a content filter rule" }, { "info": { "name": "Delete a content filter rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/content-filter/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Delete a content filter rule" }, { "info": { "name": "List custom response rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/custom-response", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ] }, "docs": "List custom response rules" }, { "info": { "name": "Create a custom response rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/custom-response", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a custom response rule" }, { "info": { "name": "Get details of a custom response rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/custom-response/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Get details of a custom response rule" }, { "info": { "name": "Update a custom response rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/custom-response/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a custom response rule" }, { "info": { "name": "Delete a custom response rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/custom-response/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Delete a custom response rule" }, { "info": { "name": "List edge function rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/function", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ] }, "docs": "List edge function rules" }, { "info": { "name": "Create an edge function rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/function", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an edge function rule" }, { "info": { "name": "Get details of an edge function rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/function/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Get details of an edge function rule" }, { "info": { "name": "Update an edge function rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/function/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an edge function rule" }, { "info": { "name": "Delete an edge function rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/function/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Delete an edge function rule" }, { "info": { "name": "List header rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/headers", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ] }, "docs": "List header rules" }, { "info": { "name": "Create a header rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/headers", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a header rule" }, { "info": { "name": "Get details of a header rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/headers/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Get details of a header rule" }, { "info": { "name": "Update a header rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/headers/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a header rule" }, { "info": { "name": "Delete a header rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/headers/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Delete a header rule" }, { "info": { "name": "List proxy rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/proxy", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" } ] }, "docs": "List proxy rules" }, { "info": { "name": "Create a proxy rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/proxy", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a proxy rule" }, { "info": { "name": "Get details of a proxy rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/proxy/:rule", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" }, { "name": "rule", "value": "", "type": "path" } ] }, "docs": "Get details of a proxy rule" }, { "info": { "name": "Update a proxy rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/proxy/:rule", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" }, { "name": "rule", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a proxy rule" }, { "info": { "name": "Delete a proxy rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/proxy/:rule", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" }, { "name": "rule", "value": "", "type": "path" } ] }, "docs": "Delete a proxy rule" }, { "info": { "name": "List redirect rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/redirect", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" } ] }, "docs": "List redirect rules" }, { "info": { "name": "Create a redirect rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/redirect", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a redirect rule" }, { "info": { "name": "Get details of a redirect rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/redirect/:rule", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" }, { "name": "rule", "value": "", "type": "path" } ] }, "docs": "Get details of a redirect rule" }, { "info": { "name": "Update a redirect rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/redirect/:rule", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" }, { "name": "rule", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a redirect rule" }, { "info": { "name": "Delete a redirect rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/redirect/:rule", "params": [ { "name": "organization", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "path" }, { "name": "rule", "value": "", "type": "path" } ] }, "docs": "Delete a redirect rule" }, { "info": { "name": "List serve static rules", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/serve-static", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ] }, "docs": "List serve static rules" }, { "info": { "name": "Create a serve static rule", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/serve-static", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a serve static rule" }, { "info": { "name": "Get details of a serve static rule", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/serve-static/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Get details of a serve static rule" }, { "info": { "name": "Update a serve static rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/serve-static/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a serve static rule" }, { "info": { "name": "Delete a serve static rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/projects/:project/rules/serve-static/:rule", "params": [ { "name": "organization", "value": "", "type": "path", "description": "Organization identifier" }, { "name": "project", "value": "", "type": "path", "description": "Project identifier" }, { "name": "rule", "value": "", "type": "path", "description": "Rule identifier" } ] }, "docs": "Delete a serve static rule" } ] }, { "info": { "name": "Tokens", "type": "folder" }, "items": [ { "info": { "name": "List API tokens scoped to this organization", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/tokens", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List API tokens scoped to this organization" }, { "info": { "name": "Create a new API token scoped to this organization", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/tokens", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new API token scoped to this organization" }, { "info": { "name": "Revoke an API token", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v2/organizations/:organization/tokens/:token_id", "params": [ { "name": "organization", "value": "test-org", "type": "path", "description": "Organization identifier" }, { "name": "token_id", "value": "42", "type": "path", "description": "Token ID to revoke" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Revoke an API token" } ] }, { "info": { "name": "AI Models", "type": "folder" }, "items": [ { "info": { "name": "List available AI models for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/models", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "feature", "value": "embeddings", "type": "query", "description": "Filter models by supported feature" } ] }, "docs": "List available AI models for an organization" }, { "info": { "name": "Get AI Model Details", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/models/:modelId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "modelId", "value": "amazon.nova-lite-v1:0", "type": "path", "description": "The model identifier (e.g., amazon.nova-lite-v1:0)" } ] }, "docs": "Retrieves detailed information about a specific Bedrock model from the catalog.\n *\n * **Features:**\n * - Complete pricing breakdown (input/output per million tokens)\n * - Context window and output token limits\n * - Supported features (chat, vision, streaming, embeddings)\n * - Model availability and deprecation status\n * - Release date for version tracking\n *\n * **Example Model IDs:**\n * - `amazon.nova-lite-v1:0` - Default multimodal model\n * - `anthrop" } ] }, { "info": { "name": "AI Sessions", "type": "folder" }, "items": [ { "info": { "name": "List chat sessions with multi-tenant filtering", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/sessions", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "userId", "value": "", "type": "query", "description": "Filter sessions by user ID" }, { "name": "sessionGroup", "value": "", "type": "query", "description": "Filter by session group. Returns only sessions matching the specified group." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of sessions to return (default 50, max 100)" }, { "name": "offset", "value": "", "type": "query", "description": "Offset for pagination" }, { "name": "model", "value": "", "type": "query", "description": "Filter by model ID" } ] }, "docs": "Lists active sessions for an organization with flexible filtering options.\n *\n * **Query Combinations:**\n * 1. By Organization (default): Returns all sessions in the organization\n * 2. By Organization + Group: `?sessionGroup=drupal-prod` - Sessions in a specific group\n * 3. By User: `?userId=user-123` - All sessions for a user\n * 4. By User + Group: `?userId=user-123&sessionGroup=drupal-prod` - User's sessions in a specific group\n *\n * **Use Cases:**\n * - List" }, { "info": { "name": "Create a new chat session with multi-tenant isolation", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/sessions", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an AI session with automatic expiration (60 min default, 24h max). Sessions are isolated by organization. Use userId to identify the user creating the session. Use sessionGroup for logical grouping. Use metadata for additional custom data. Filter sessions by userId or sessionGroup when listing." }, { "info": { "name": "Get a specific chat session", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/sessions/:sessionId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "sessionId", "value": "", "type": "path", "description": "The session ID" } ] }, "docs": "Get a specific chat session" }, { "info": { "name": "Update Session", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/sessions/:sessionId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "sessionId", "value": "", "type": "path", "description": "The session ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates session with new conversation messages and tracks token usage. Appends new messages to conversation history and updates session stats.\n *\n * **Typical Flow:**\n * 1. Get session to retrieve conversation history\n * 2. Call AI inference with full message history\n * 3. Update session with new user + assistant messages" }, { "info": { "name": "Delete a chat session", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/sessions/:sessionId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "sessionId", "value": "", "type": "path", "description": "The session ID" } ] }, "docs": "Delete a chat session" }, { "info": { "name": "Extend Session Expiration", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/sessions/:sessionId/extend", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "sessionId", "value": "", "type": "path", "description": "The session ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Extends the expiration time of an active session. Useful for keeping long-running conversations alive." } ] }, { "info": { "name": "AI Task Management", "type": "folder" }, "items": [ { "info": { "name": "List tasks with optional filtering", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tasks", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "taskListId", "value": "world-1", "type": "query", "description": "Filter tasks by task list ID. Task lists are implicit groupings - any string can be used." }, { "name": "status", "value": "pending", "type": "query", "description": "Filter tasks by status" }, { "name": "assignedAgentId", "value": "agent-code-reviewer", "type": "query", "description": "Filter tasks by assigned agent ID" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of tasks to return (default 50, max 100)" }, { "name": "dependsOn", "value": "550e8400-e29b-41d4-a716-446655440000", "type": "query", "description": "Reverse lookup: find tasks that depend on this task ID. Returns tasks waiting for the specified task to complete." }, { "name": "includeDetails", "value": "", "type": "query", "description": "When using dependsOn, return full task objects in addition to IDs. Default false (IDs only for lightweight responses)." } ] }, "docs": "Lists tasks for an organization with optional filtering. Filters can be combined for powerful queries.\n *\n * **Filter Examples:**\n * - All tasks in a list: ?taskListId=world-1\n * - Pending tasks in a list: ?taskListId=world-1&status=pending\n * - Tasks assigned to an agent: ?assignedAgentId=agent-code-reviewer\n * - Combined: ?taskListId=world-1&status=in_progress&assignedAgentId=agent-1\n *\n * **Reverse Dependency Lookup:**\n * Use `dependsOn` to find tasks that " }, { "info": { "name": "Create a new task", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tasks", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new task for multi-agent coordination and workflow orchestration.\n *\n * **Key Features:**\n * - **Persistent State**: Tasks survive across conversations and sessions\n * - **Agent Assignment**: Pre-assign tasks to specific agents\n * - **Task Lists**: Group related tasks using taskListId (implicit - no need to create lists first)\n * - **Dependencies**: Define task dependencies for workflow orchestration\n * - **Metadata**: Store flexible JSON metadata for task-s" }, { "info": { "name": "Get task details", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tasks/:taskId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "taskId", "value": "", "type": "path", "description": "The task UUID" } ] }, "docs": "Retrieves detailed information about a specific task including status, progress, dependencies, and results." }, { "info": { "name": "Update a task", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tasks/:taskId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "taskId", "value": "550e8400-e29b-41d4-a716-446655440000", "type": "path", "description": "The task UUID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing task. All fields are optional - only provided fields will be updated.\n *\n * **Status Transitions:**\n * - Changing from **pending** to **in_progress** automatically sets startedAt timestamp\n * - Changing to **completed**, **failed**, or **cancelled** automatically sets completedAt timestamp\n * - Changing to **blocked** automatically sets blockedAt timestamp\n * - Changing from **blocked** to **in_progress** or **pending** clears blocked fields\n * - C" }, { "info": { "name": "Delete a task", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tasks/:taskId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "taskId", "value": "", "type": "path", "description": "The task UUID" }, { "name": "cascade", "value": "", "type": "query", "description": "If true, delete task and all dependent tasks recursively" } ] }, "docs": "Permanently deletes a task. This action cannot be undone.\n *\n * **Dependency Protection:**\n * By default, deletion is blocked if other tasks depend on this task (TASK_HAS_DEPENDENTS error).\n * This prevents breaking workflows.\n *\n * **Cascade Delete:**\n * Use `?cascade=true` to delete the task AND all tasks that depend on it recursively.\n * Useful for cleaning up entire dependency chains.\n *\n * **Examples:**\n * - DELETE /tasks/{id} - Deletes task if no" }, { "info": { "name": "Get dependency graph for a task list", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tasks/:taskListId/dependency-graph", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "taskListId", "value": "world-1", "type": "path", "description": "The task list ID to get the dependency graph for" } ] }, "docs": "Returns the full dependency graph for all tasks in a task list.\n *\n * **Use Cases:**\n * - Visualize task dependencies in a UI (DAG diagram)\n * - Analyze workflow structure and critical paths\n * - Find starting tasks (roots) and terminal tasks (leaves)\n * - Plan parallel execution by identifying independent task groups\n *\n * **Response Structure:**\n * - `taskCount`: Total number of tasks in the list\n * - `roots`: Task IDs with no dependencies (starting poin" } ] }, { "info": { "name": "AI Monitoring", "type": "folder" }, "items": [ { "info": { "name": "Get AI usage statistics", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/usage", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "month", "value": "", "type": "query", "description": "Month to retrieve statistics for (YYYY-MM format)" } ] }, "docs": "Get AI usage statistics" } ] }, { "info": { "name": "AI Inference", "type": "folder" }, "items": [ { "info": { "name": "Chat inference via API Gateway (buffered responses) with multimodal support", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/chat", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding.\n *\n * **Execution Modes:**\n * - **Sync Mode** (default): Standard JSON response, waits for completion (200 response)\n * - **Async Mode**: Set `async: true` for long-running tasks with polling (202 response)\n *\n * **Async/Durable Mode (`async: true`):**\n * - Returns immediately with `requestId` and `pollUrl` (HTTP 202)\n * - Uses A" }, { "info": { "name": "Chat inference via streaming endpoint (true HTTP streaming) with multimodal support", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/chat/stream", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Streams responses from the AI streaming subdomain using Server-Sent Events (SSE). Tokens are streamed in real-time as they are generated.\n *\n * **Execution Modes:**\n * - **Streaming Mode** (default): Real-time SSE token-by-token responses\n * - **Async Mode**: Set `async: true` for long-running tasks with polling (202 response)\n *\n * **Async/Durable Mode (`async: true`):**\n * - Returns immediately with `requestId` and `pollUrl` (HTTP 202)\n * - Uses AWS Lambda Durab" }, { "info": { "name": "Generate text embeddings for semantic search and RAG applications", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/embeddings", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates vector embeddings for text content using embedding models. Used for semantic search, document similarity, and RAG applications.\n *\n * **Features:**\n * - Single text or batch processing (up to 100 texts)\n * - Configurable dimensions (256, 512, 1024, 8192 for Titan v2)\n * - Optional normalization to unit length\n * - Usage tracking for billing\n *\n * **Use Cases:**\n * - Semantic search across documents\n * - Similarity matching for content recommendat" }, { "info": { "name": "Generate images with Amazon Nova Canvas", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/image-generation", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates images using Amazon Nova Canvas image generation model.\n *\n * **Region Restriction:** Nova Canvas is ONLY available in:\n * - `us-east-1` (US East, N. Virginia)\n * - `ap-northeast-1` (Asia Pacific, Tokyo)\n * - `eu-west-1` (Europe, Ireland)\n * ❌ NOT available in `ap-southeast-2` (Sydney)\n *\n * **Supported Task Types:**\n * - **TEXT_IMAGE**: Basic text-to-image generation\n * - **TEXT_IMAGE with Conditioning**: Layout-guided generation using edge dete" }, { "info": { "name": "Get Durable Execution Status", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/chat/executions/:identifier", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "identifier", "value": "XkdVWiEfSwMEPrw=", "type": "path", "description": "Either the requestId from async response, or full executionArn (URL-encoded)" } ] }, "docs": "Poll the status of an async/durable chat execution.\n *\n * **When to use:** After starting chat inference with `async: true`, poll this endpoint\n * to check execution status and retrieve results when complete.\n *\n * **Identifier:** Accepts either:\n * - `requestId` (recommended): The short ID returned from the async request\n * - `executionArn`: The full AWS Lambda durable execution ARN (must be URL-encoded)\n *\n * **Statuses:**\n * - `pending`: Execution is st" }, { "info": { "name": "Submit Client Tool Results (Callback)", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/chat/callback", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit tool execution results to resume a suspended durable execution.\n *\n * **When to use:** When polling the execution status returns `waiting_callback`, use this endpoint\n * to submit the results of client-executed tools. The execution will then resume.\n *\n * **Flow:**\n * 1. Start async chat with client-executed tools (`autoExecute: []` or tools not in autoExecute list)\n * 2. Poll status until `waiting_callback`\n * 3. Execute tools locally using `pendingTools` " } ] }, { "info": { "name": "AI Tools", "type": "folder" }, "items": [ { "info": { "name": "List available built-in tools for function calling", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tools", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Retrieves all available built-in tools that can be used with function calling. These tools can be included in `toolConfig` when making AI inference requests.\n *\n * **Available Built-in Tools:**\n * - `get_weather`: Get current weather for a location using Open-Meteo API\n * - `calculate`: Perform basic mathematical calculations (add, subtract, multiply, divide)\n * - `search_web`: Search the web for information (mock implementation)\n * - `generate_image`: Generate images wit" }, { "info": { "name": "List tool names only (lightweight response)", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tools/names", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications." }, { "info": { "name": "Get async tool execution status and result", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tools/executions/:executionId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "executionId", "value": "", "type": "path", "description": "Tool execution identifier" } ] }, "docs": "Retrieves the status and result of an async tool execution. Used for polling long-running tools like image generation.\n *\n * **Async Tool Execution Pattern:**\n * This endpoint enables a polling pattern for long-running tools that would otherwise hit API Gateway's 30-second timeout.\n *\n * **Flow:**\n * 1. AI requests tool use (e.g., `generate_image`)\n * 2. Chat API returns `toolUse` with execution tracking info\n * 3. Client starts polling this endpoint with the `exe" }, { "info": { "name": "Get Tool Orchestration Status (Async Tool Polling)", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tools/orchestrations/:orchestrationId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "orchestrationId", "value": "", "type": "path", "description": "Orchestration identifier for aggregated async tool executions" } ] }, "docs": "Retrieves the status and synthesized result of a multi-tool async execution orchestration.\n *\n * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`).\n * For durable batch processing orchestrations, see `GET /orchestrations` endpoints.\n *\n * **Orchestration Pattern:**\n * When the AI requests multiple async tools simultaneously, an orchestration is created\n * to track all tool executions and synthesize their results into a single cohere" }, { "info": { "name": "List tool executions for monitoring and debugging", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/tools/executions", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "status", "value": "", "type": "query", "description": "Filter by execution status" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of executions to return" } ] }, "docs": "Lists recent async tool executions for an organization. Useful for debugging, monitoring, and building admin UIs.\n *\n * **Query Patterns:**\n * - All recent executions: `GET /ai/tools/executions`\n * - Filter by status: `GET /ai/tools/executions?status=running`\n * - Limit results: `GET /ai/tools/executions?limit=20`\n *\n * **Results:**\n * - Ordered by creation time (newest first)\n * - Limited to 50 by default (configurable via `limit` parameter)\n * - Only sho" } ] }, { "info": { "name": "AI Agents", "type": "folder" }, "items": [ { "info": { "name": "List AI Agents", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "group", "value": "", "type": "query", "description": "Optional group filter (e.g., 'development', 'compliance')" } ] }, "docs": "Lists all AI agents for an organization. Agents are pre-configured AI assistants with specific system prompts, model settings, and tool permissions.\n *\n * **Features:**\n * - Filter by group (e.g., 'development', 'compliance')\n * - Organization-scoped\n * - Returns agent configurations without execution history" }, { "info": { "name": "Create AI Agent", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new AI agent with specific configuration, system prompt, and tool permissions.\n *\n * **Agent Configuration:**\n * - **System Prompt**: Instructions that guide the agent's behavior\n * - **Model**: Which foundation model to use (e.g., 'amazon.nova-pro-v1:0')\n * - **Temperature**: Creativity level (0-1)\n * - **Allowed Tools**: Which tools the agent can auto-execute\n * - **Allowed Collections**: Vector DB collections for RAG\n * - **Group**: Optional categoriz" }, { "info": { "name": "Get Agent Details", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents/:agentId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ] }, "docs": "Retrieves detailed configuration for a specific AI agent." }, { "info": { "name": "Update Agent", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents/:agentId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing AI agent configuration. All fields except agentId, organizationId, createdAt, and createdBy can be updated." }, { "info": { "name": "Delete Agent", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents/:agentId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ] }, "docs": "Permanently deletes an AI agent. This action cannot be undone." }, { "info": { "name": "Chat with AI Agent", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents/:agentId/chat", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "agentId", "value": "", "type": "path", "description": "The agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a chat session with a specific AI agent. The agent's configuration (system prompt, temperature, model, allowed tools) is automatically applied.\n *\n * **Key Features:**\n * - **Session Management**: Automatic session creation and state tracking\n * - **Multi-turn Conversations**: Full conversation history maintained server-side\n * - Agent's system prompt is prepended to conversation\n * - Only agent's allowed tools are available\n * - All tools are auto-executed " }, { "info": { "name": "Get Agent Overlay", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents/:agentId/overlay", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "agentId", "value": "", "type": "path", "description": "Global agent identifier (e.g., 'quantgov-code')" } ] }, "docs": "Returns the per-organisation overlay for a global agent, plus base agent metadata for UI context. If no overlay exists the response contains `overlay: null`. Overlays can only be created for global agents." }, { "info": { "name": "Upsert Agent Overlay", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents/:agentId/overlay", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "agentId", "value": "", "type": "path", "description": "Global agent identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or replaces the per-organisation overlay for a global agent. PUT is full replacement — omitted optional fields are removed. Include `version` from a prior GET to enable compare-and-swap (409 on conflict). Omit for last-writer-wins." }, { "info": { "name": "Delete Agent Overlay", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/agents/:agentId/overlay", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "agentId", "value": "", "type": "path", "description": "Global agent identifier" } ] }, "docs": "Removes the per-organisation overlay for a global agent, reverting it to platform defaults." } ] }, { "info": { "name": "AI Custom Tools", "type": "folder" }, "items": [ { "info": { "name": "List Custom Tools", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/custom-tools", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Lists all registered custom edge function tools for an organization." }, { "info": { "name": "Register Custom Edge Function Tool", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/custom-tools", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Registers a custom edge function as a tool that AI models can invoke. Provide `edgeFunctionCode` (JavaScript) and the API will deploy it to the CDN, compute the edge function URL, and register the tool.\n *\n * **Edge Function Contract:**\n * - Edge functions must accept POST requests with JSON payload\n * - Expected request format: `{ 'toolName': '...', 'input': {...}, 'orgId': '...' }`\n * - Must return JSON response with either `result` or `error` field\n *\n * **Idempote" }, { "info": { "name": "Get Custom Tool", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/custom-tools/:toolName", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "toolName", "value": "", "type": "path", "description": "The tool name to retrieve" } ] }, "docs": "Retrieves a single registered custom tool by name." }, { "info": { "name": "Delete Custom Tool", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/custom-tools/:toolName", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "toolName", "value": "", "type": "path", "description": "The tool name to delete" } ] }, "docs": "Deletes a custom tool registration and its deployed edge function." } ] }, { "info": { "name": "AI Skills", "type": "folder" }, "items": [ { "info": { "name": "List Organization's Skills", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "tag", "value": "", "type": "query", "description": "Filter skills by tag" }, { "name": "namespace", "value": "", "type": "query", "description": "Filter skills by collection namespace (e.g. 'superpowers')" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of skills to return" } ] }, "docs": "Lists all skills available to the organization. Skills are reusable prompts,\n * workflows, or instructions that can be assigned to agents or invoked directly.\n *\n * **Skill Sources:**\n * - `inline`: Created directly via the API\n * - `skills.sh`: Imported from skills.sh registry\n * - `github`: Imported from a GitHub repository\n * - `local`: Uploaded from local file" }, { "info": { "name": "Create Inline Skill", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new skill with inline content. Use this for custom skills\n * that are defined directly in your organization.\n *\n * **Trigger Conditions:**\n * - Natural language description of when to use the skill\n * - Used by AI to determine when to suggest or apply the skill\n * - Example: 'When the user asks about code review or security analysis'" }, { "info": { "name": "Get Skill Details", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/:skillId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "skillId", "value": "", "type": "path", "description": "The skill ID" } ] }, "docs": "Retrieves full details of a skill including its content, source information, and metadata." }, { "info": { "name": "Update Skill", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/:skillId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "skillId", "value": "", "type": "path", "description": "The skill ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing skill. For imported skills, this updates\n * local overrides (name, tags, triggerCondition) but not the source content.\n * Use the sync endpoint to update source content." }, { "info": { "name": "Delete Skill", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/:skillId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "skillId", "value": "", "type": "path", "description": "The skill ID" } ] }, "docs": "Permanently deletes a skill. This will also remove it from any agents that have it assigned." }, { "info": { "name": "Import Skill from External Source", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/import", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports a skill from an external source like skills.sh registry or GitHub repository.\n *\n * **Supported Sources:**\n * - `skills.sh`: Import from the skills.sh community registry\n * - `github`: Import from a GitHub repository (public or private)\n *\n * **Version Control:**\n * - Skills can be pinned to specific versions\n * - Use the sync endpoint to update to latest version" }, { "info": { "name": "Sync Skill from Source", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/:skillId/sync", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "skillId", "value": "", "type": "path", "description": "The skill ID" } ] }, "docs": "Re-fetches skill content from its original source.\n * Only applicable to skills imported from external sources (skills.sh, github).\n * Inline skills cannot be synced.\n *\n * **Version Behavior:**\n * - If version is pinned, fetches that specific version\n * - If no version specified, fetches latest" }, { "info": { "name": "List Skill Collections", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/collections", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Lists distinct namespaces (collections) for the organization, with skill counts and skill names for each collection." }, { "info": { "name": "Import Skill Collection from GitHub", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/import-collection", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Discovers all skill directories under a given path in a GitHub repository\n * and imports each as a skill within the specified namespace. Each subdirectory must contain a SKILL.md file.\n *\n * **Namespace:** Used for grouping and slash-command invocation (e.g., `/superpowers:brainstorming`).\n *\n * **Idempotent:** If a skill with the same namespace + name already exists, it is updated." }, { "info": { "name": "Sync Skill Collection", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/collections/:namespace/sync", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "namespace", "value": "", "type": "path", "description": "Collection namespace" } ] }, "docs": "Re-syncs all skills in a namespace from their GitHub source. Detects new\n * skills added to the repository and flags skills removed from the source. Does NOT auto-delete removed skills." }, { "info": { "name": "Delete Skill Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/skills/collections/:namespace", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "namespace", "value": "", "type": "path", "description": "Collection namespace" } ] }, "docs": "Permanently deletes all skills in the specified namespace." } ] }, { "info": { "name": "AI Vector Database", "type": "folder" }, "items": [ { "info": { "name": "List Vector Database Collections", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Lists all vector database collections (knowledge bases) for an organization." }, { "info": { "name": "Create Vector Database Collection", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new vector database collection (knowledge base category) for semantic search. Collections store documents with embeddings for RAG (Retrieval Augmented Generation).\n *\n * **Use Cases:**\n * - Product documentation ('docs')\n * - Company policies ('policies')\n * - Support knowledge base ('support')\n * - Technical specifications ('specs')" }, { "info": { "name": "Get Collection Details", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections/:collectionId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection ID" } ] }, "docs": "Get detailed information about a specific vector database collection." }, { "info": { "name": "Delete Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections/:collectionId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection ID" } ] }, "docs": "Deletes a vector database collection and all its documents. This action cannot be undone." }, { "info": { "name": "List Documents in Collection", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections/:collectionId/documents", "params": [ { "name": "organisation", "value": "", "type": "path" }, { "name": "collectionId", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "query", "description": "Filter by document key" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] }, "docs": "Lists documents in a collection with pagination. Supports filtering by document key." }, { "info": { "name": "Upload Documents to Collection", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections/:collectionId/documents", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads documents to a vector database collection with automatic embedding generation. Documents are chunked (if needed), embedded using the collection's embedding model, and stored.\n *\n * **Supported Content:**\n * - Plain text content\n * - URLs to fetch content from\n * - Markdown documents\n *\n * **Metadata:**\n * Each document can include metadata (title, source_url, section, tags) that is returned with search results." }, { "info": { "name": "Delete Documents from Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections/:collectionId/documents", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "Organisation machine name" }, { "name": "collectionId", "value": "", "type": "path", "description": "Collection UUID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete documents from a collection. Supports three deletion modes:\n *\n * 1. **Purge All** - Set `purgeAll: true` to delete ALL documents in the collection\n *\n * 2. **By Document IDs** - Provide `documentIds` array with specific document UUIDs\n *\n * 3. **By Metadata** - Provide `metadata` object with `field` and `values` to delete documents where the metadata field matches any of the values\n *\n * **Drupal Integration:**\n * When using with Drupal AI Search, use " }, { "info": { "name": "Semantic Search Query", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/vector-db/collections/:collectionId/query", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs semantic search on a collection using vector similarity. Returns the most relevant documents based on meaning, not keyword matching.\n *\n * **Three Search Modes:**\n *\n * 1. **Text Query** - Provide `query` string, server generates embedding\n * - Query text is embedded using the collection's embedding model\n * - Embeddings are cached for repeated queries\n *\n * 2. **Vector Query** - Provide pre-computed `vector` array\n * - Skip embedding generat" } ] }, { "info": { "name": "AI File Storage", "type": "folder" }, "items": [ { "info": { "name": "List Files", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/files", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "filter", "value": "", "type": "query", "description": "JSON-encoded metadata filter. Supports exact match and array contains filters." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum files to return" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor from previous response" } ] }, "docs": "Lists files stored in S3 for this organization with optional metadata filtering and pagination." }, { "info": { "name": "Upload File to S3", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/files", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads a file to S3 storage for later retrieval.\n *\n * **Two Upload Modes:**\n *\n * 1. **Direct Upload (≤7MB):** Send base64-encoded content in request body.\n *\n * 2. **Presigned URL Upload (any size):** Set `requestUploadUrl: true` to get a presigned S3 PUT URL, then upload directly to S3.\n *\n * **Supported Content Types:**\n * - Images: image/png, image/jpeg, image/gif, image/webp, image/svg+xml\n * - Documents: application/pdf, text/plain, text/markdown, " }, { "info": { "name": "Get File", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/files/:fileId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "fileId", "value": "", "type": "path", "description": "The file ID" } ] }, "docs": "Retrieves file metadata and a presigned download URL (valid for 1 hour)." }, { "info": { "name": "Delete File", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/files/:fileId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "fileId", "value": "", "type": "path", "description": "The file ID" } ] }, "docs": "Deletes a file from S3 storage." } ] }, { "info": { "name": "AI Orchestrations", "type": "folder" }, "items": [ { "info": { "name": "List Durable Orchestrations", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "status", "value": "", "type": "query", "description": "Filter by orchestration status" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor from previous response" } ] }, "docs": "List durable orchestrations for an organization with optional filtering.\n *\n * **Note:** This is different from `/tools/orchestrations` which handles async tool execution\n * polling. These durable orchestrations are for long-running batch processing loops.\n *\n * **Filter Options:**\n * - `status`: Filter by orchestration status\n * - `limit`: Max results (default 20, max 100)\n * - `cursor`: Pagination cursor" }, { "info": { "name": "Create Durable Orchestration", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new durable orchestration for batch processing.\n *\n * **Input Sources:**\n * - `static`: Process a fixed list of items\n * - `task_query`: Process tasks matching a query\n * - `generator`: AI generates items from a prompt\n *\n * **Stop Conditions:**\n * - `all_complete`: Stop when all items processed\n * - `max_iterations`: Stop after N iterations\n * - `condition`: AI evaluates a prompt to decide\n * - `manual`: Run until manually stopped\n *\n " }, { "info": { "name": "Get Durable Orchestration", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations/:orchestrationId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "orchestrationId", "value": "orch_1704067200_abc123xyz", "type": "path", "description": "Orchestration identifier" } ] }, "docs": "Get orchestration details including status and progress.\n *\n * **Progress Tracking:**\n * - `total`: Total items to process\n * - `completed`: Successfully processed\n * - `failed`: Failed processing\n * - `pending`: Awaiting processing" }, { "info": { "name": "Delete Durable Orchestration", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations/:orchestrationId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "orchestrationId", "value": "", "type": "path", "description": "Orchestration identifier" } ] }, "docs": "Delete an orchestration. Can only delete orchestrations in completed, failed, or cancelled status." }, { "info": { "name": "Start Durable Orchestration", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations/:orchestrationId/start", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "orchestrationId", "value": "", "type": "path", "description": "Orchestration identifier" } ] }, "docs": "Start a pending orchestration. Only works on orchestrations created with `autoStart: false`." }, { "info": { "name": "Pause Durable Orchestration", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations/:orchestrationId/pause", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "orchestrationId", "value": "", "type": "path", "description": "Orchestration identifier" } ] }, "docs": "Pause a running orchestration. The current batch will complete, but no new batches will start. Can be resumed later." }, { "info": { "name": "Resume Durable Orchestration", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations/:orchestrationId/resume", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "orchestrationId", "value": "", "type": "path", "description": "Orchestration identifier" } ] }, "docs": "Resume a paused orchestration. Processing continues from where it left off." }, { "info": { "name": "Cancel Durable Orchestration", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations/:orchestrationId/cancel", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "orchestrationId", "value": "", "type": "path", "description": "Orchestration identifier" } ] }, "docs": "Cancel an orchestration permanently. Cannot be resumed. Any in-progress items will complete, but no new processing starts." }, { "info": { "name": "List Orchestration Batches", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/orchestrations/:orchestrationId/batches", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation machine name" }, { "name": "orchestrationId", "value": "", "type": "path", "description": "Orchestration identifier" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of batches to return" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor from previous response" } ] }, "docs": "Get history of batches processed by this orchestration. Returns paginated batch records with status and item counts." } ] }, { "info": { "name": "AI Slack Bots", "type": "folder" }, "items": [ { "info": { "name": "List Slack Bots", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/slack-bots", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Lists all Slack bots configured for the organization. Each bot is backed by an AI agent and can be connected to a Slack workspace. Agent configuration fields are flattened onto each bot object." }, { "info": { "name": "Create Slack Bot", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/slack-bots", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Slack bot with inline AI agent configuration. A backing agent is created automatically — callers do not need to manage agents separately.\n *\n * **Setup Types:**\n * - `quant`: Quant-managed Slack app — uses shared OAuth credentials\n * - `byo`: Bring Your Own — customer provides their own Slack app credentials" }, { "info": { "name": "Get Slack Bot", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/slack-bots/:botId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "botId", "value": "", "type": "path", "description": "The Slack bot ID" } ] }, "docs": "Retrieves details for a specific Slack bot including its configuration, connection status, and flattened agent configuration." }, { "info": { "name": "Update Slack Bot", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/slack-bots/:botId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "botId", "value": "", "type": "path", "description": "The Slack bot ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Slack bot's configuration and/or its backing agent. Only provided fields are updated." }, { "info": { "name": "Delete Slack Bot", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/slack-bots/:botId", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "botId", "value": "", "type": "path", "description": "The Slack bot ID" } ] }, "docs": "Permanently deletes a Slack bot, disconnects it from the workspace, and deletes its backing AI agent." }, { "info": { "name": "Search Slack Workspace Users", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/slack-bots/:botId/workspace/users", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "botId", "value": "", "type": "path", "description": "The Slack bot ID" }, { "name": "q", "value": "", "type": "query", "description": "Search query to filter users by name" } ] }, "docs": "Searches users in the Slack workspace connected to this bot. Requires the bot to be connected via OAuth." }, { "info": { "name": "Search Slack Workspace Channels", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/slack-bots/:botId/workspace/channels", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "botId", "value": "", "type": "path", "description": "The Slack bot ID" }, { "name": "q", "value": "", "type": "query", "description": "Search query to filter channels by name" } ] }, "docs": "Searches channels in the Slack workspace connected to this bot. Requires the bot to be connected via OAuth." } ] }, { "info": { "name": "AI Governance", "type": "folder" }, "items": [ { "info": { "name": "Get AI governance configuration for an organisation", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/governance", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Get AI governance configuration for an organisation" }, { "info": { "name": "Update AI governance configuration for an organisation", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/governance", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update AI governance configuration for an organisation" }, { "info": { "name": "Get AI spend summary for an organisation", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/governance/spend", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Get AI spend summary for an organisation" } ] }, { "info": { "name": "AI Filter Policies", "type": "folder" }, "items": [ { "info": { "name": "List AI filter policies for an organisation", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/filter-policies", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "List AI filter policies for an organisation" }, { "info": { "name": "Create an AI filter policy for an organisation", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/filter-policies", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an AI filter policy for an organisation" }, { "info": { "name": "Get a specific AI filter policy", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/filter-policies/:policyId", "params": [ { "name": "organisation", "value": "", "type": "path" }, { "name": "policyId", "value": "", "type": "path" } ] }, "docs": "Get a specific AI filter policy" }, { "info": { "name": "Update a specific AI filter policy", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/filter-policies/:policyId", "params": [ { "name": "organisation", "value": "", "type": "path" }, { "name": "policyId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific AI filter policy" }, { "info": { "name": "Delete a specific AI filter policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/filter-policies/:policyId", "params": [ { "name": "organisation", "value": "", "type": "path" }, { "name": "policyId", "value": "", "type": "path" } ] }, "docs": "Delete a specific AI filter policy" }, { "info": { "name": "Enable a specific AI filter policy", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/filter-policies/:policyId/enable", "params": [ { "name": "organisation", "value": "", "type": "path" }, { "name": "policyId", "value": "", "type": "path" } ] }, "docs": "Enable a specific AI filter policy" }, { "info": { "name": "Disable a specific AI filter policy", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/filter-policies/:policyId/disable", "params": [ { "name": "organisation", "value": "", "type": "path" }, { "name": "policyId", "value": "", "type": "path" } ] }, "docs": "Disable a specific AI filter policy" } ] }, { "info": { "name": "AI Usage", "type": "folder" }, "items": [ { "info": { "name": "Get AI usage summary for the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/ai/usage/me", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Get AI usage summary for the authenticated user" } ] }, { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "Get all applications for an organisation", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Get all applications for an organisation" }, { "info": { "name": "Create a new application", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new application" }, { "info": { "name": "Get a single application", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "", "type": "path", "description": "The application ID" } ] }, "docs": "Get a single application" }, { "info": { "name": "Delete an application", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "", "type": "path", "description": "The application ID" } ] }, "docs": "Delete an application" }, { "info": { "name": "Get ECR login credentials", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/ecr-login", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" } ] }, "docs": "Get ECR login credentials" } ] }, { "info": { "name": "Commands", "type": "folder" }, "items": [ { "info": { "name": "Get all commands for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/environments/:environment/commands", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get all commands for an environment" }, { "info": { "name": "Create a command for an environment", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/environments/:environment/commands", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a command for an environment" }, { "info": { "name": "Get a command", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/environments/:environment/commands/:command", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "command", "value": "test-cmd", "type": "path", "description": "The command ID" } ] }, "docs": "Get a command" } ] }, { "info": { "name": "Compose", "type": "folder" }, "items": [ { "info": { "name": "Get the compose file for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/compose", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get the compose file for an environment" }, { "info": { "name": "Partially Update Environment Compose Definition", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/compose", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially updates top-level fields of the environment's compose definition, such as architecture, task-level CPU/Memory, or min/max scaling capacity. Only fields included in the request body are modified. The 'containers' array, if provided, REPLACES the existing containers array; if omitted, the existing containers are NOT modified by this PATCH operation. (For modifying individual containers, use PATCH /containers/{containerName}). This triggers a validation, registers a new task definition, a" }, { "info": { "name": "Validate a compose file", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/compose/validate", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "imageSuffix", "value": "pr-456", "type": "query", "description": "Optional. Image tag suffix to apply during translation. Transforms internal image tags to consistent '{containerName}-{suffix}' format (e.g., 'nginx-pr-456'). External images are left unchanged. Useful for feature branch deployments." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix" } ] }, { "info": { "name": "Containers", "type": "folder" }, "items": [ { "info": { "name": "Get the containers in an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/containers", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get the containers in an environment" }, { "info": { "name": "Update a container in an environment", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/containers/:container", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "container", "value": "test-container", "type": "path", "description": "The container ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a container in an environment" } ] }, { "info": { "name": "Cron", "type": "folder" }, "items": [ { "info": { "name": "Get all cron jobs for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/cron", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get all cron jobs for an environment" }, { "info": { "name": "Create a new cron job", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/cron", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new cron job" }, { "info": { "name": "Get a cron job", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/cron/:cron", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "cron", "value": "", "type": "path", "description": "The cron job ID" } ] }, "docs": "Get a cron job" }, { "info": { "name": "Update a cron job", "type": "http" }, "http": { "method": "PATCH", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/cron/:cron", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "cron", "value": "", "type": "path", "description": "The cron job ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a cron job" }, { "info": { "name": "Delete a cron job", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/cron/:cron", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "cron", "value": "", "type": "path", "description": "The cron job ID" } ] }, "docs": "Delete a cron job" }, { "info": { "name": "Get all runs for a cron job", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/cron/:cron/runs", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "cron", "value": "test-cron", "type": "path", "description": "The cron job ID" } ] }, "docs": "Get all runs for a cron job" }, { "info": { "name": "Get a cron run", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/cron/:cron/runs/:run", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "cron", "value": "test-cron", "type": "path", "description": "The cron job ID" }, { "name": "run", "value": "", "type": "path", "description": "The cron run ID" } ] }, "docs": "Get a cron run" } ] }, { "info": { "name": "Environments", "type": "folder" }, "items": [ { "info": { "name": "Get all environments for an application", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" } ] }, "docs": "Get all environments for an application" }, { "info": { "name": "Create a new environment", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new environment" }, { "info": { "name": "Get a single environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get a single environment" }, { "info": { "name": "Update Environment Compose Definition", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment", "params": [ { "name": "organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the entire task definition for the environment based on the provided multi-container compose definition. This will create a new task definition revision and update the ECS service, triggering a redeployment. Optionally accepts minCapacity and maxCapacity at the root level for convenience." }, { "info": { "name": "Delete an environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Delete an environment" }, { "info": { "name": "Update the state of an environment", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/state", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the state of an environment" }, { "info": { "name": "Get the logs for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/logs", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "startTime", "value": "", "type": "query", "description": "Start time for log retrieval (ISO 8601 format or Unix timestamp)" }, { "name": "endTime", "value": "", "type": "query", "description": "End time for log retrieval (ISO 8601 format or Unix timestamp)" }, { "name": "containerName", "value": "", "type": "query", "description": "Filter logs by specific container name" }, { "name": "filterPattern", "value": "", "type": "query", "description": "CloudWatch Logs filter pattern for searching log content" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return per page" }, { "name": "nextToken", "value": "", "type": "query", "description": "Pagination token from previous response for retrieving next page of results" } ] }, "docs": "Retrieves logs from CloudWatch for the specified environment with optional filtering by time range, container, and pattern matching. Supports pagination via nextToken." }, { "info": { "name": "Get the metrics for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/metrics", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "startTime", "value": "", "type": "query", "description": "Start time for metrics retrieval (Unix timestamp in milliseconds)" }, { "name": "endTime", "value": "", "type": "query", "description": "End time for metrics retrieval (Unix timestamp in milliseconds)" }, { "name": "period", "value": "", "type": "query", "description": "Period in seconds for metric aggregation (e.g., 60 for 1 minute, 300 for 5 minutes)" }, { "name": "statistics", "value": "", "type": "query", "description": "Comma-separated list of CloudWatch statistics (e.g., Average, Maximum, Minimum, Sum, SampleCount)" }, { "name": "containerName", "value": "", "type": "query", "description": "Filter metrics by specific container name" } ] }, "docs": "Retrieves CloudWatch metrics for the specified environment with optional filtering by time range, container, and metric configuration." }, { "info": { "name": "List the sync operations for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/sync/:type", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "type", "value": "", "type": "path", "description": "The sync type" } ] }, "docs": "List the sync operations for an environment" }, { "info": { "name": "Perform a sync operation from a source environment to the current environment", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/sync/:type", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "type", "value": "", "type": "path", "description": "The sync type" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Perform a sync operation from a source environment to the current environment" } ] }, { "info": { "name": "Backup Management", "type": "folder" }, "items": [ { "info": { "name": "List backups for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/backups/:type", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "type", "value": "", "type": "path", "description": "The backup type" }, { "name": "order", "value": "", "type": "query", "description": "Sort order for backups by creation date (asc = oldest first, desc = newest first)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of backups to return (max 100)" }, { "name": "createdBefore", "value": "", "type": "query", "description": "Only return backups created before this ISO 8601 timestamp (e.g., 2025-01-01T00:00:00Z)" }, { "name": "createdAfter", "value": "", "type": "query", "description": "Only return backups created after this ISO 8601 timestamp (e.g., 2024-12-01T00:00:00Z)" }, { "name": "status", "value": "", "type": "query", "description": "Filter backups by status" }, { "name": "nextToken", "value": "", "type": "query", "description": "Token for retrieving the next page of results" } ] }, "docs": "Retrieves a list of backups (database or filesystem) for the environment with status, size, and metadata. Supports filtering and ordering via query parameters." }, { "info": { "name": "Create a backup for an environment", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/backups/:type", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "type", "value": "", "type": "path", "description": "The backup type" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a backup for an environment" }, { "info": { "name": "Delete a backup", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/backups/:type/:backupId", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "type", "value": "", "type": "path", "description": "The backup type" }, { "name": "backupId", "value": "", "type": "path", "description": "The backup ID" } ] }, "docs": "Delete a backup" }, { "info": { "name": "Generate a download URL for a backup", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/backups/:type/:backupId/download", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "type", "value": "", "type": "path", "description": "The backup type" }, { "name": "backupId", "value": "", "type": "path", "description": "The backup ID" } ] }, "docs": "Generate a download URL for a backup" } ] }, { "info": { "name": "ScalingPolicy", "type": "folder" }, "items": [ { "info": { "name": "Get the scaling policies for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/scaling-policies", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get the scaling policies for an environment" }, { "info": { "name": "Update the scaling policy for an environment", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/scaling-policies", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the scaling policy for an environment" }, { "info": { "name": "Delete the scaling policy for an environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/scaling-policies/:policyName", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "policyName", "value": "", "type": "path", "description": "The policy name" } ] }, "docs": "Delete the scaling policy for an environment" } ] }, { "info": { "name": "SSH Access", "type": "folder" }, "items": [ { "info": { "name": "Get SSH access credentials for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/ssh-access", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get SSH access credentials for an environment" } ] }, { "info": { "name": "Variables", "type": "folder" }, "items": [ { "info": { "name": "Get all variables for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:api_organisation/applications/:api_application/environments/:api_environment/variables", "params": [ { "name": "api_organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "api_application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "api_environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get all variables for an environment" }, { "info": { "name": "Bulk set/replace environment variables", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:api_organisation/applications/:api_application/environments/:api_environment/variables", "params": [ { "name": "api_organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "api_application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "api_environment", "value": "test-env", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk set/replace environment variables" }, { "info": { "name": "Update a variable", "type": "http" }, "http": { "method": "PUT", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:api_organisation/applications/:api_application/environments/:api_environment/variables/:api_variable", "params": [ { "name": "api_organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "api_application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "api_environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "api_variable", "value": "", "type": "path", "description": "The variable key" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a variable" }, { "info": { "name": "Delete a variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:api_organisation/applications/:api_application/environments/:api_environment/variables/:api_variable", "params": [ { "name": "api_organisation", "value": "", "type": "path", "description": "The organisation ID" }, { "name": "api_application", "value": "", "type": "path", "description": "The application ID" }, { "name": "api_environment", "value": "", "type": "path", "description": "The environment ID" }, { "name": "api_variable", "value": "", "type": "path", "description": "The variable key" } ] }, "docs": "Delete a variable" } ] }, { "info": { "name": "Volumes", "type": "folder" }, "items": [ { "info": { "name": "Get all volumes for an environment", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/volumes", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ] }, "docs": "Get all volumes for an environment" }, { "info": { "name": "Create a new volume", "type": "http" }, "http": { "method": "POST", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/volumes", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new volume" }, { "info": { "name": "Get a volume", "type": "http" }, "http": { "method": "GET", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/volumes/:volume", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "volume", "value": "", "type": "path", "description": "The volume ID" } ] }, "docs": "Get a volume" }, { "info": { "name": "Delete a volume", "type": "http" }, "http": { "method": "DELETE", "url": "https://dashboard.quantcdn.io/api/v3/organizations/:organisation/applications/:application/environments/:environment/volumes/:volume", "params": [ { "name": "organisation", "value": "test-org", "type": "path", "description": "The organisation ID" }, { "name": "application", "value": "test-app", "type": "path", "description": "The application ID" }, { "name": "environment", "value": "test-env", "type": "path", "description": "The environment ID" }, { "name": "volume", "value": "", "type": "path", "description": "The volume ID" } ] }, "docs": "Delete a volume" } ] } ], "bundled": true }