Update workspace 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 updateWorkspaceDeploymentsConfig mutation to add or update workspace-level overrides:

mutation {
  updateWorkspaceDeploymentsConfig(
    workspaceUuid: "<workspace-id>"
    deploymentsConfigOverride: {
      deploymentLifecycle: {
        deployRollback: {
          enabled: true
        }
      }
    }
    reason: "Enable deploy rollback for all deployments in this workspace"
  ) {
    id
    config
    removedPaths
  }
}

Starting in APC 2.2, the deploymentsConfigOverride argument is the complete override for the Workspace. It replaces the stored override, so a key that you leave out stops overriding and inherits its value from the cluster or platform again. To change one key, read the stored override with the workspaceDeploymentsConfig query, change the key, and send the whole object. APC rejects an empty object. To clear the override, use deleteWorkspaceDeploymentsConfig. In APC 2.1 and earlier, the argument accepts a partial JSON object. Keys you provide are merged into the existing workspace override, and keys you omit are left unchanged. To remove a key, set its value to the string "DELETE_KEY". In APC 2.2, this removes a value that the Workspace inherits. APC stores the removal with the override, so include it in every later save. On a key with a platform default outside helm, "DELETE_KEY" only withdraws the Workspace’s value. The following example shows only the key you’re removing. In APC 2.2, send it with the rest of the stored override, or the other keys stop overriding. In APC 2.1 and earlier, "DELETE_KEY" removes the key from the stored override. See Remove a setting.

mutation {
  updateWorkspaceDeploymentsConfig(
    workspaceUuid: "<workspace-id>"
    deploymentsConfigOverride: {
      deploymentLifecycle: {
        deployRollback: {
          enabled: "DELETE_KEY"
        }
      }
    }
    reason: "Remove deploy rollback override, revert to cluster/platform default"
  ) {
    id
    config
    removedPaths
  }
}

removedPaths is available starting in APC 2.2. It lists the paths that the Workspace override removes, each as an array of key segments. A removal that only withdraws isn’t listed. APC rejects values set to null, and the error names the key. For the full config governance model these overrides participate in, see Config governance.

⌘I