Example mutations overview | Astronomer Documentation

The examples on this page show common ways to use the APC API — they’re not a complete API reference. For the full, interactive API documentation for your installation, including every available query, mutation, and type, go to https://houston.<your-base-domain>/v1, and click on the Docs tab. See Develop and test APC API queries for more on using the built-in GraphQL explorer.

The following pages show example GraphQL mutations for common APC API operations, grouped by the resource they act on.

Deployment lifecycle

Upsert Deployment
Delete Deployment

Deployment configuration

Update Deployment configuration
Delete Deployment configuration
Update a Deployment image
Update a Deployment KEDA config
Update environment variables

User accounts

Create Deployment user
Delete user
Verify user email
Bypass user email verification
Add a System Admin

Service accounts and roles

Create System Service Account Token
Create a Deployment service account
Add a Deployment user role
Remove a Deployment user role
Update a Deployment user’s role

Teams

Create a team
Update a team
Remove a team
Assign a team role
Update a team’s role
Remove a team’s role

Workspace configuration

Update workspace configuration
Delete workspace configuration

Clusters

Update a cluster
Deregister a cluster

For read-only operations, see Example Queries.