API reference
REST API reference for the Facets control plane, generated from published OpenAPI specs, covering deployments, releases, artifacts, and resource lifecycle.
Two OpenAPI surfaces, generated directly from the published specs.
Deployment Controller
Facets Deployment Controller API reference: REST endpoints for the designer, environment clusters, releases, deployments, artifacts, and resource overrides.
Artifact Management
Facets Artifact Management API to record build artifacts produced by CI pipelines and bind them to release streams for deployment across qualified environments.
Base URL
Every endpoint is served from your own control plane, so the base URL is your control plane host, for example https://myorg.console.facets.cloud. The sample requests on the endpoint pages show facetsdemo.console.facets.cloud as a placeholder. Replace it with your host before running them.
Authentication
The Facets API uses HTTP Basic authentication. The username is the email address you sign in with, and the password is a personal access token generated in the Control Plane. See Authentication Setup for how to generate one.
Commands
Command reference for raptor, the kubectl-style Facets CLI: verbs and resource groups for projects, blueprints, releases, artifacts, and IaC modules.
Deployment Controller
Facets Deployment Controller API reference: REST endpoints for the designer, environment clusters, releases, deployments, artifacts, and resource overrides.