API Recipes
Task-oriented guides for working with the Facets control plane API, authentication, branches, resources, releases.
Prose walkthroughs for the most common API workflows. Each recipe pairs a goal with the request shapes and example payloads. For pure endpoint reference, see Deployment Controller and Artifact Management.
Authentication Setup
This page will help you generate a basic authentication token for use with Facets API requests.
Create a New Branch
API recipe: create a new branch via API.
Create a New Resource
API recipe: create a new resource in a blueprint via API.
Update a Resource
API recipe: update an existing resource's configuration via API.
Get Blueprint Resources
API recipe: list all resources in a blueprint.
Branch Creation and Resource Management
API recipe: create branches and manage resources programmatically.
Bulk Enable/Disable Resources
API recipe: enable or disable multiple resources in bulk.
Enable/Disable Resources in a Blueprint
API recipe: enable or disable resources at the blueprint level.
Enable/Disable Resources in an Environment
API recipe: enable or disable resources for a specific environment.
Register an Artifact
This API is primarily used for integration with existing CI systems or pushing a build manually from local. The API registers an artifact for a given release stream. All environments qualified for that release stream will get the artifact in queue.
Authentication Setup
This page will help you generate a basic authentication token for use with Facets API requests.