Skip to content
QuantCDN
GitHub
X
Select theme
Dark
Light
Auto
Welcome
Guides
Getting Started
Deploy a static site
Deploy a cloud application
Deploy from GitHub
Setup a CDN project
GitHub Integration
Connecting GitHub
Start from a template
Import a repository
Framework Guides
Deploy Astro
Deploy Next.js
Migrations
Migrate from Netlify
Migrate from Vercel
Account Management
Data Deletion & Offboarding
Security
Improve security headers
Configure WAF
Setup reCAPTCHA on forms
CI/CD
Deploy via CI/CD
Manual GitHub Actions setup
Purging
Using cache keys
Purge via the API
Purge via the dashboard
Custom error pages
Integrations
CMS Integrations Overview
WordPress
Drupal
Get Started
Using quant_cron
Using quant_purger
Using the Drupal Quant Search module
Running a content seed
Go-Live Process for CMS Integrations
Dashboard
Site-wide alert banners
Basic authentication
Managing content and revisions
Crawler
Custom HTTP headers
Managing domains
Using Quant Forms
Get started with the Quant dashboard
Page Rules
CDN Proxy
Web Application Firewall (WAF)
S3 sync
Enable Quant Search
Team management
Content CLI
Overview
commands
quant init
quant info
Reference
quant deploy
quant publish
quant unpublish
quant delete
quant file
quant page
quant redirect
quant purge
quant search
quant scan
Edge functions
quant waflogs
guides
CI/CD pipelines
Get started
Cloud CLI
Overview
commands
Authentication
Organizations
Reference
Applications
Environments
Projects
Platforms
Backups
SSH
Crawlers
Visual regression
guides
SSH access
Backups
Visual regression testing
Get started
Edge Functions
Auth Middleware
Content filters
Edge functions
Inline functions
Key Value Stores
Scheduled Functions
API
Ideal API client workflow
Content API
Search API
Get started with the Content API
Get started with the Project API
Custom search records
DNS Management
DNS Management Overview
Creating DNS Zones
Managing DNS Records
CDN Integration
Security
Security Overview
Container Image Security
WAF
CRS
Core Ruleset: 910xxx
Core Ruleset: 920xxx
Core Ruleset: 930xxx
Core Ruleset: 931xxx
Core Ruleset: 932xxx
Custom rule definitions
WAF
Managing the firewall
Terraform
Get Started
Cloud Applications
Introduction to Quant Cloud
What is Quant Cloud?
Key Concepts
Prerequisites
Understanding Deployments
Importing Docker Compose Files
Application Management
Creating a New Application
Listing Your Applications
Deleting an Application
Releasing Your Application on a Custom Domain
Environment Management
Understanding Environments
Creating an Environment
Managing an Environment
Understanding and Configuring Container Settings
Deleting an Environment
Deployment Credentials & Instructions
Enabling SSH Access into a Container
Managing Backups
Syncing Environments
Team & Access Control
Permissions & roles
Environment Variables & Secrets
Managing Environment Variables
Managing Secrets
Persistent Storage (Volumes)
Understanding Persistent Storage Volumes
Listing Defined Volumes
Defining a New Persistent Storage Volume
Scaling Your Application
Manual Scaling (Fixed Instance Count)
Auto-Scaling Policies
Monitoring Application Health
Viewing Application Metrics
Accessing Application Logs
Startup Grace Period
Managing Scheduled Tasks (Cron Jobs)
Configuring Cron Jobs
Viewing Cron Run History
Executing Commands in Environment
Running Ad-hoc Commands
Viewing Command Status
Deployment Hooks
Post-Deployment Scripts with quant-entrypoint.d
GitHub Actions CI/CD
GitHub Actions Overview
Init Action
Compose Action
Environment Action
Environment Vars Action
Sync Action
Backup Action
Managed Cache (Valkey)
Managed Valkey Cache
Guides
Quant AI
New
Overview
AI Search
Get started
Chat widget
Search page
Managing the index
Settings
Agents
Overview
Get started
Configuration
Testing
Supply-chain agent
Tools
Get started
AI tool creator
Deploy & test
Skills
Get started
Collections
Workflows
Get started
Workflow editor
Triggers
Executions
Webhook secrets
Vector Database
Get started
Documents
Search
Slack Bots
Overview
Get started
Setup types
Agents & routing
Configuration
Use cases
Orchestrations
Tasks
API Reference
OpenAI Compatibility
Quant Studio
New
Overview
Try the demo
Creating a project
Content schemas
Content management
Visual editor
Click-to-edit
AI assistant
Code editor
Branches & environments
Review & publishing
Permissions & roles
Deployments
Settings
Edge functions
Migration
Search
Forms
Media browser
File browser
API reference
Content API
Overview
meta
Overview
/global-meta
/url-meta
/revisions
/revisions/{revision}
content
Overview
/
/redirect
/unpublish
/publish/{revision}
/delete
search
Overview
/search
/search
/search
/search/all
misc
Project validate
Purge CDN cache
Cloud API
Overview
AI Agents
Overview
List AI Agents
Create AI Agent
Get Agent Details
Update Agent
Delete Agent
Chat with AI Agent
Get Agent Overlay
Upsert Agent Overlay
Delete Agent Overlay
AI Custom Tools
Overview
List Custom Tools
Register Custom Edge Function Tool
Get Custom Tool
Delete Custom Tool
AI File Storage
Overview
List Files
Upload File to S3
Get File
Delete File
AI Inference
Overview
Chat inference via API Gateway (buffered responses) with multimodal support
Chat inference via streaming endpoint (true HTTP streaming) with multimodal support
Generate text embeddings for semantic search and RAG applications
Generate images with Amazon Nova Canvas
Get Durable Execution Status
Submit Client Tool Results (Callback)
AI Models
Overview
List available AI models for an organization
Get AI Model Details
AI Orchestrations
Overview
List Durable Orchestrations
Create Durable Orchestration
Get Durable Orchestration
Delete Durable Orchestration
Start Durable Orchestration
Pause Durable Orchestration
Resume Durable Orchestration
Cancel Durable Orchestration
List Orchestration Batches
AI Search
Overview
Get AI Search status for a project
Enable AI Search for a project
Disable AI Search for a project
Get AI Search public access and rate limit settings
Update AI Search public access and rate limit settings
List indexed pages with cursor pagination
Ingest pages into the AI Search index
Delete pages by URLs or patterns
Purge the entire AI Search index
Semantic search across the AI Search index
Get usage statistics for the AI Search site
Get the most popular AI Search queries
RAG chat with AI Search content
List AI Search ingest jobs
Trigger a crawler run that ingests into AI Search
Get AI Search ingest job status
Get per-page ingest results for a crawl job
AI Sessions
Overview
List chat sessions with multi-tenant filtering
Create a new chat session with multi-tenant isolation
Get a specific chat session
Update Session
Delete a chat session
Extend Session Expiration
AI Skills
Overview
List Organization's Skills
Create Inline Skill
Get Skill Details
Update Skill
Delete Skill
Import Skill from External Source
Sync Skill from Source
List Skill Collections
Import Skill Collection from GitHub
Sync Skill Collection
Delete Skill Collection
AI Task Management
Overview
List tasks with optional filtering
Create a new task
Get task details
Update a task
Delete a task
Get dependency graph for a task list
AI Tools
Overview
List available built-in tools for function calling
List tool names only (lightweight response)
Get async tool execution status and result
Get Tool Orchestration Status (Async Tool Polling)
List tool executions for monitoring and debugging
AI Vector Database
Overview
List Vector Database Collections
Create Vector Database Collection
Get Collection Details
Delete Collection
List Documents in Collection
Upload Documents to Collection
Delete Documents from Collection
Semantic Search Query
Applications
Overview
Get all applications for an organisation
Create a new application
Get a single application
Delete an application
Get ECR login credentials
Backup Management
Overview
List backups for an environment
Create a backup for an environment
Delete a backup
Generate a download URL for a backup
CDN Metrics
Overview
Get hourly metrics
Get daily metrics
Get monthly metrics
Commands
Overview
Get all commands for an environment
Create a command for an environment
Get a command
Compose
Overview
Get the compose file for an environment
Partially Update Environment Compose Definition
Validate a compose file
Containers
Overview
Get the containers in an environment
Update a container in an environment
CrawlerSchedules
Overview
List schedules for a crawler
Add a new schedule
Show a specific schedule
Delete a schedule
Edit a schedule
Crawlers
Overview
List crawlers for the project
Create a new crawler
Get details of a single crawler
Delete a crawler
Update a crawler
Run a crawler
Get all runs for a crawler
Get a run by ID
Cron
Overview
Get all cron jobs for an environment
Create a new cron job
Get a cron job
Delete a cron job
Update a cron job
Get all runs for a cron job
Get a cron run
Domains
Overview
List all domains for a project
Add a new domain
Get details of a single domain
Delete a domain
Renew the SSL certificate for a domain
Environments
Overview
Get all environments for an application
Create a new environment
Get a single environment
Update Environment Compose Definition
Delete an environment
Update the state of an environment
Get the logs for an environment
Get the metrics for an environment
List the sync operations for an environment
Perform a sync operation from a source environment to the current environment
Headers
Overview
List custom headers for a project
Create or update custom headers
Delete custom headers
KV
Overview
List key-value stores
Add a kv store
Get a kv store
Delete a kv store
Link a KV store to another project
Unlink a KV store from this project
List items in a kv store
Add an item to a kv store
Get an item from a kv store
Update an item in a kv store
Delete an item from a kv store
Organizations
Overview
Retrieve all organizations
Get details of a single organization
Projects
Overview
Retrieve all projects for an organization
Create a new project
Get details of a single project
Delete a project
Update a project
Purge
Overview
Purge cache via URL or cache keys
Rules
Overview
List authentication rules
Create an authentication rule
Get details of an authentication rule
Delete an authentication rule
Update an authentication rule
List bot challenge rules
Create a bot challenge rule
Get details of a bot challenge rule
Delete a bot challenge rule
Update a bot challenge rule
List content filter rules
Create a content filter rule
Get details of a content filter rule
Delete a content filter rule
Update a content filter rule
List custom response rules
Create a custom response rule
Get details of a custom response rule
Delete a custom response rule
Update a custom response rule
List edge function rules
Create an edge function rule
Get details of an edge function rule
Delete an edge function rule
Update an edge function rule
List header rules
Create a header rule
Get details of a header rule
Delete a header rule
Update a header rule
List proxy rules
Create a proxy rule
Get details of a proxy rule
Delete a proxy rule
Update a proxy rule
List redirect rules
Create a redirect rule
Get details of a redirect rule
Delete a redirect rule
Update a redirect rule
List serve static rules
Create a serve static rule
Get details of a serve static rule
Delete a serve static rule
Update a serve static rule
ScalingPolicy
Overview
List Scaling Policies
Upsert Scaling Policy
Delete Scaling Policy
SSH Access
Overview
Get SSH access credentials for an environment
Variables
Overview
Get all variables for an environment
Bulk set/replace environment variables
Update a variable
Delete a variable
Volumes
Overview
Get all volumes for an environment
Create a new volume
Get a volume
Delete a volume
Tokens
Overview
List API tokens scoped to this organization
Create a new API token scoped to this organization
Revoke an API token
Subscription
Overview
Cloud-app cost breakdown for the subscription page
AI
Overview
Organisation AI usage breakdown (subscription page parity)
AI Slack Bots
Overview
List Slack Bots
Create Slack Bot
Get Slack Bot
Update Slack Bot
Delete Slack Bot
Search Slack Workspace Users
Search Slack Workspace Channels
AI Governance
Overview
Get AI governance configuration for an organisation
Update AI governance configuration for an organisation
Get AI spend summary for an organisation
AI Filter Policies
Overview
List AI filter policies for an organisation
Create an AI filter policy for an organisation
Get a specific AI filter policy
Update a specific AI filter policy
Delete a specific AI filter policy
Enable a specific AI filter policy
Disable a specific AI filter policy
AI Usage
Overview
Get AI usage summary for the authenticated user
Restore Management
Overview
Restore a database backup to a target environment
Restore a filesystem backup to a target environment
Get the status of a restore operation
GitHub
X
Select theme
Dark
Light
Auto
Overview
Rules
Section titled “Rules”
Edge rules (redirects, authentication, proxies, etc.)
Operations
Section titled “Operations”
GET
/api/v2/organizations/{organization}/projects/{project}/rules/auth
POST
/api/v2/organizations/{organization}/projects/{project}/rules/auth
GET
/api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge
POST
/api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge
GET
/api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/content-filter
POST
/api/v2/organizations/{organization}/projects/{project}/rules/content-filter
GET
/api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/custom-response
POST
/api/v2/organizations/{organization}/projects/{project}/rules/custom-response
GET
/api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/function
POST
/api/v2/organizations/{organization}/projects/{project}/rules/function
GET
/api/v2/organizations/{organization}/projects/{project}/rules/function/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/function/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/function/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/headers
POST
/api/v2/organizations/{organization}/projects/{project}/rules/headers
GET
/api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/proxy
POST
/api/v2/organizations/{organization}/projects/{project}/rules/proxy
GET
/api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/redirect
POST
/api/v2/organizations/{organization}/projects/{project}/rules/redirect
GET
/api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule}
GET
/api/v2/organizations/{organization}/projects/{project}/rules/serve-static
POST
/api/v2/organizations/{organization}/projects/{project}/rules/serve-static
GET
/api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule}
DELETE
/api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule}
PATCH
/api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule}
