Update Deployment configuration with the APC API

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.

Use the updateDeploymentConfig mutation to add or update deployment-level overrides:

1mutation {
2 updateDeploymentConfig(
3 deploymentUuid: "<deployment-id>"
4 deploymentsConfigOverride: {
5 airflowComponents: {
6 triggerer: {
7 enabled: false
8 }
9 }
10 }
11 reason: "Disable triggerer for this specific deployment"
12 ) {
13 id
14 config
15 }
16}

The same DELETE_KEY mechanism applies — set a key’s value to "DELETE_KEY" to remove it from the stored override:

1mutation {
2 updateDeploymentConfig(
3 deploymentUuid: "<deployment-id>"
4 deploymentsConfigOverride: {
5 airflowComponents: {
6 triggerer: {
7 enabled: "DELETE_KEY"
8 }
9 }
10 }
11 reason: "Remove triggerer override, revert to workspace/cluster default"
12 ) {
13 id
14 config
15 }
16}

For the full config governance model these overrides participate in, see Config governance.