API Recipes

Task-oriented guides for the Facets control plane API, covering authentication, branch creation, resource management, and enabling or disabling resources.

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

Generate a personal access token in the Facets Control Plane to use as the password for basic authentication when making Facets API requests.

Create a New Branch

API recipe to create a new branch in a Facets blueprint with a POST request, using the stackName and branch path parameters and basic authentication.

Create a New Resource

API recipe to create a new resource in a Facets blueprint branch with a POST request, passing the resourceName and resourceType in the request body.

Update a Resource

API recipe to update an existing resource in a Facets blueprint branch with a PUT request, replacing its JSON content by directory, filename, and type.

Get Blueprint Resources

API recipe to list every resource within a Facets blueprint branch using a GET request, syncing any changes from the linked Git repository.

Branch Creation and Resource Management

API recipe to create a branch in a Facets blueprint, then create and update resources on it programmatically using REST calls before merging to master.

Bulk Enable/Disable Resources

API recipe to enable or disable multiple Facets resources in bulk, either across an environment by clusterId or across a blueprint by stackName.

Enable/Disable Resources in a Blueprint

API recipe to enable or disable Facets resources at the blueprint level with a PUT request, toggling the disabled flag by stackName for each resource.

Enable/Disable Resources in an Environment

API recipe to enable or disable Facets resources in a specific environment with a PUT request, toggling the disabled flag by clusterId for each resource.