APC APIExample mutationsDeployment configuration

Update environment variables 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.

To programmatically update environment variables, you need:

  • A Deployment ID. To retrieve this value, run astro deployment list or request the id value in the workspaceDeployment query.
  • A Deployment release name: To retrieve this value, run astro deployment list in your Workspace. Alternatively, you can copy the Release name from your Deployment’s Settings tab in the Astro Private Cloud UI.

Then, in your GraphQL Playground, run the following:

1mutation UpdateDeploymentVariables {
2  updateDeploymentVariables(
3    deploymentUuid: ID! = "<deployment-id>",
4  	releaseName: String! = "<deployment-release-name>",
5    environmentVariables: [
6      {key: "<environment-variable-1>",
7      value: "<environment-variable-value-1>",
8      isSecret: <true-or-false>},
9      {key: "<environment-variable-2>",
10      value: "<environment-variable-value-2>",
11      isSecret: <true-or-false>}
12    ]
13  ) {
14    key
15    value
16    isSecret
17  }
18}