Platform API Reference

The CloudQuery Platform exposes a REST API you can use to automate platform workflows, integrate with CI/CD pipelines, and manage resources programmatically.

Full interactive reference: Interactive API Reference ↗

Authentication

All API requests require an API key passed in the Authorization header:


Authorization: Bearer <YOUR_API_KEY>

Create an API key in Organization Settings → API Keys. See API Keys for instructions and available roles.

Some endpoints (such as the AI Query Writer) are only available in the UI and cannot be called with API keys.

Base URL


https://<YOUR_PLATFORM_URL>/api

Replace <YOUR_PLATFORM_URL> with your CloudQuery Platform deployment URL (e.g. cloudquery.mycompany.com).

Quick-start examples

List syncs


curl -s \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://<YOUR_PLATFORM_URL>/api/teams/<TEAM>/syncs

Fetch audit log entries


curl -s \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  "https://<YOUR_PLATFORM_URL>/api/audit-logs?limit=50"

List users (admin)


curl -s \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  https://<YOUR_PLATFORM_URL>/api/users

API categories

The Platform API is organized into the following categories. See Interactive API Reference ↗ for full endpoint documentation, request/response schemas, and examples.

Category	What it covers
`syncs`	Create, manage, and monitor sync jobs
`plugins`	Manage installed integrations
`policies`	Create and manage compliance policies and policy groups
`alerts`	Configure alert rules and notification thresholds
`audit-logs`	Query the audit log for user and API activity
`rbac`	Manage roles and permissions
`users`	Provision and manage user accounts
`teams`	Manage team membership and settings
`reports`	Access and manage reports and report templates
`queries`	Manage saved SQL queries, filters, and tags
`custom-columns`	Create custom columns on asset tables
`alerts`	Configure alert rules, notification thresholds, and notification destinations
`admin`	Platform-wide settings, SAML SSO, and user administration
`healthcheck`	Platform health and version info

Common patterns

Pagination

Most list endpoints support limit and offset query parameters:


curl -s \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  "https://<YOUR_PLATFORM_URL>/api/audit-logs?limit=100&offset=0"

Error responses

The API returns standard HTTP status codes. Error bodies follow this structure:


{
  "message": "Description of the error",
  "status": 404
}

Next Steps

API Keys — create and manage API keys
Audit Log — track API usage
Policies — manage compliance policies via API
Full API Reference ↗ — complete interactive documentation