> ## Documentation Index > Fetch the complete documentation index at: https://astronomer.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update an environment object > Update an existing Deployment level or Workspace level environment object. ## OpenAPI ````yaml /astro/api/v-1-beta-1/platform/openapi.yaml post /organizations/{organizationId}/environment-objects/{environmentObjectId} openapi: 3.0.3 info: contact: {} description: Astro Platform API title: Astro Platform API version: v1beta1 servers: - url: https://api.astronomer.io/platform/v1beta1 security: - JWT: [] tags: - description: >- A `cluster` object represents an Astro cluster, which is a Kubernetes cluster that hosts the infrastructure required to run Deployments. Make requests to `cluster` endpoints to manage your standard and dedicated clusters. See [Create a dedicated cluster](https://astronomer.io/docs/astro/create-dedicated-cluster). name: Cluster - description: >- The `organization` object contains the metadata and configurations of an Astro Organization. It does not include objects within the Organization, such as users and clusters. Make requests to `organization` endpoints to view and update high level settings for your Organization, including settings related to authentication and billing. To manage resources within an Organization, make requests to the endpoints related to those resources, such as `users`. See [Billing](https://astronomer.io/docs/astro/manage-billing), [Set up single sign-on](https://astronomer.io/docs/astro/configure-idp), and [Manage domains](https://astronomer.io/docs/astro/manage-domains). name: Organization - description: >- The `options` object represents all possible configurations for a given Astro component. Make requests to the `options` object to get the configuration constraints for creating or updating a given Astro component. name: Options - description: >- The `workspace` object represents an Astro Workspace, which is a collection of Deployments that can be accessed by a specific group of users. It contains metadata about a Workspace, but does not contain objects within the Workspace such as users and Deployments. Make requests to `workspace` endpoints to manage high level details about your Workspace. To manage resources within a Workspace, make requests to the endpoints related to those resources, such as `users`, and use the `workspaceIds` parameter to filter results by Workspace. See [Configure Workspaces](https://astronomer.io/docs/astro/manage-workspaces). name: Workspace - name: notification-channels x-group: Notification Channels paths: /organizations/{organizationId}/environment-objects/{environmentObjectId}: post: tags: - Environment summary: Update an environment object description: >- Update an existing Deployment level or Workspace level environment object. operationId: UpdateEnvironmentObject parameters: - description: The ID of the Organization to which the environment object belongs. in: path name: organizationId required: true schema: type: string - description: The environment object's ID. in: path name: environmentObjectId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEnvironmentObjectRequest' description: The request body for updating an environment object. required: true x-originalParamName: data responses: '200': content: application/json: schema: $ref: '#/components/schemas/EnvironmentObject' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal Server Error security: - JWT: [] components: schemas: UpdateEnvironmentObjectRequest: properties: airflowVariable: $ref: '#/components/schemas/UpdateEnvironmentObjectAirflowVariableRequest' autoLinkDeployments: description: >- Whether or not to automatically link Deployments to the environment object. Only applicable for WORKSPACE scope type: boolean connection: $ref: '#/components/schemas/UpdateEnvironmentObjectConnectionRequest' excludeLinks: description: >- The links to exclude from the environment object. Only applicable for WORKSPACE scope items: $ref: '#/components/schemas/ExcludeLinkEnvironmentObjectRequest' type: array links: description: >- The Deployments that Astro links to the environment object. Only applicable for WORKSPACE scope items: $ref: '#/components/schemas/UpdateEnvironmentObjectLinkRequest' type: array metricsExport: $ref: '#/components/schemas/UpdateEnvironmentObjectMetricsExportRequest' type: object EnvironmentObject: properties: airflowVariable: $ref: '#/components/schemas/EnvironmentObjectAirflowVariable' autoLinkDeployments: description: >- Whether or not to automatically link Deployments to the environment object type: boolean connection: $ref: '#/components/schemas/EnvironmentObjectConnection' createdAt: description: >- The time when the environment object was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ` type: string createdBy: $ref: '#/components/schemas/BasicSubjectProfile' excludeLinks: description: The excluded links for the environment object items: $ref: '#/components/schemas/EnvironmentObjectExcludeLink' type: array id: description: The ID of the environment object type: string links: description: The Deployments linked to the environment object items: $ref: '#/components/schemas/EnvironmentObjectLink' type: array metricsExport: $ref: '#/components/schemas/EnvironmentObjectMetricsExport' objectKey: description: The key for the environment object type: string objectType: description: The type of environment object enum: - CONNECTION - AIRFLOW_VARIABLE - METRICS_EXPORT type: string scope: description: The scope of the environment object enum: - WORKSPACE - DEPLOYMENT type: string scopeEntityId: description: The ID of the scope entity where the environment object is created type: string sourceScope: description: >- The source scope of the environment object, if it is resolved from a link enum: - WORKSPACE - DEPLOYMENT type: string sourceScopeEntityId: description: >- The source scope entity ID of the environment object, if it is resolved from a link type: string updatedAt: description: >- The time when the environment object was updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ` type: string updatedBy: $ref: '#/components/schemas/BasicSubjectProfile' required: - objectKey - objectType - scope - scopeEntityId type: object Error: properties: message: type: string requestId: type: string statusCode: maximum: 600 minimum: 400 type: integer required: - message - requestId - statusCode type: object UpdateEnvironmentObjectAirflowVariableRequest: properties: value: description: The value of the Airflow variable type: string type: object UpdateEnvironmentObjectConnectionRequest: properties: authTypeId: description: The ID for the connection auth type type: string extra: description: Extra connection details, if any type: object host: description: The host address for the connection type: string login: description: The username used for the connection type: string password: description: The password used for the connection type: string port: description: The port for the connection type: integer schema: description: The schema for the connection type: string type: description: The type of connection type: string required: - type type: object ExcludeLinkEnvironmentObjectRequest: properties: scope: description: Scope of the entity to exclude for environment object enum: - DEPLOYMENT type: string scopeEntityId: description: Entity ID to exclude for the environment object type: string required: - scope - scopeEntityId type: object UpdateEnvironmentObjectLinkRequest: properties: overrides: $ref: '#/components/schemas/UpdateEnvironmentObjectOverridesRequest' scope: description: Scope of the entity to link the environment object enum: - DEPLOYMENT type: string scopeEntityId: description: Entity ID to link the environment object type: string required: - scope - scopeEntityId type: object UpdateEnvironmentObjectMetricsExportRequest: properties: authType: description: >- The type of authentication to use when connecting to the remote endpoint enum: - BASIC - AUTH_TOKEN type: string basicToken: description: The bearer token to connect to the remote endpoint type: string endpoint: description: The Prometheus endpoint where the metrics are exported type: string exporterType: description: The type of exporter enum: - PROMETHEUS type: string headers: additionalProperties: type: string description: >- Add key-value pairs to the HTTP request headers made by Astro when connecting to the remote endpoint type: object labels: additionalProperties: type: string description: >- Any key-value pair metrics labels for your export. You can use these to filter your metrics in downstream applications. type: object password: description: The password to connect to the remote endpoint type: string username: description: The username to connect to the remote endpoint type: string type: object EnvironmentObjectAirflowVariable: properties: isSecret: description: Whether the value is a secret or not type: boolean value: description: >- The value of the Airflow variable. If the value is a secret, the value returned is empty type: string required: - isSecret - value type: object EnvironmentObjectConnection: properties: connectionAuthType: $ref: '#/components/schemas/ConnectionAuthType' extra: description: Extra connection details, if any type: object host: description: The host address for the connection type: string login: description: The username used for the connection type: string password: description: The password used for the connection type: string port: description: The port for the connection type: integer schema: description: The schema for the connection type: string type: description: The type of connection type: string required: - type type: object BasicSubjectProfile: properties: apiTokenName: description: >- The API token's name. Returned only when `SubjectType` is `SERVICEKEY`. example: my-token type: string avatarUrl: description: >- The URL for the user's profile image. Returned only when `SubjectType` is `USER`. example: https://avatar.url type: string fullName: description: The subject's full name. Returned only when `SubjectType` is `USER`. example: Jane Doe type: string id: description: The subject's ID. example: clm8qv74h000008mlf08scq7k type: string subjectType: description: The subject type. enum: - USER - SERVICEKEY example: USER type: string username: description: The subject's username. Returned only when `SubjectType` is `USER`. example: user1@company.com type: string required: - id type: object EnvironmentObjectExcludeLink: properties: scope: description: Scope of the excluded entity for environment object enum: - DEPLOYMENT type: string scopeEntityId: description: ID for the excluded entity for the environment object type: string required: - scope - scopeEntityId type: object EnvironmentObjectLink: properties: airflowVariableOverrides: $ref: '#/components/schemas/EnvironmentObjectAirflowVariableOverrides' connectionOverrides: $ref: '#/components/schemas/EnvironmentObjectConnectionOverrides' metricsExportOverrides: $ref: '#/components/schemas/EnvironmentObjectMetricsExportOverrides' scope: description: Scope of the linked entity for the environment object enum: - DEPLOYMENT type: string scopeEntityId: description: Linked entity ID the environment object type: string required: - scope - scopeEntityId type: object EnvironmentObjectMetricsExport: properties: authType: description: >- The type of authentication to use when connecting to the remote endpoint enum: - BASIC - AUTH_TOKEN type: string basicToken: description: The bearer token to connect to the remote endpoint type: string endpoint: description: The Prometheus endpoint where the metrics are exported type: string exporterType: description: The type of exporter enum: - PROMETHEUS type: string headers: additionalProperties: type: string description: >- Add key-value pairs to the HTTP request headers made by Astro when connecting to the remote endpoint type: object labels: additionalProperties: type: string description: >- Any key-value pair metrics labels for your export. You can use these to filter your metrics in downstream applications. type: object password: description: The password to connect to the remote endpoint type: string username: description: The username to connect to the remote endpoint type: string required: - endpoint - exporterType type: object UpdateEnvironmentObjectOverridesRequest: properties: airflowVariable: $ref: >- #/components/schemas/UpdateEnvironmentObjectAirflowVariableOverridesRequest connection: $ref: >- #/components/schemas/UpdateEnvironmentObjectConnectionOverridesRequest metricsExport: $ref: >- #/components/schemas/UpdateEnvironmentObjectMetricsExportOverridesRequest type: object ConnectionAuthType: properties: airflowType: description: The type of connection in Airflow type: string authMethodName: description: The name of the auth method used in the connection type: string description: description: A description of the connection auth type type: string guidePath: description: The URL to the guide for the connection auth type type: string id: description: The ID of the connection auth type type: string name: description: The name of the connection auth type type: string parameters: description: The parameters for the connection auth type items: $ref: '#/components/schemas/ConnectionAuthTypeParameter' type: array providerLogo: description: The URL of the provider logo type: string providerPackageName: description: The name of the provider package type: string required: - airflowType - authMethodName - description - id - name - parameters - providerPackageName type: object EnvironmentObjectAirflowVariableOverrides: properties: value: description: The value of the Airflow variable type: string required: - value type: object EnvironmentObjectConnectionOverrides: properties: extra: description: Extra connection details, if any type: object host: description: The host address for the connection type: string login: description: The username used for the connection type: string password: description: The password used for the connection type: string port: description: The port for the connection type: integer schema: description: The schema for the connection type: string type: description: The type of connection type: string type: object EnvironmentObjectMetricsExportOverrides: properties: authType: description: >- The type of authentication to use when connecting to the remote endpoint enum: - BASIC - AUTH_TOKEN type: string basicToken: description: The bearer token to connect to the remote endpoint type: string endpoint: description: The Prometheus endpoint where the metrics are exported type: string exporterType: description: The type of exporter enum: - PROMETHEUS type: string headers: additionalProperties: type: string description: >- Add key-value pairs to the HTTP request headers made by Astro when connecting to the remote endpoint type: object labels: additionalProperties: type: string description: >- Any key-value pair metrics labels for your export. You can use these to filter your metrics in downstream applications. type: object password: description: The password to connect to the remote endpoint type: string username: description: The username to connect to the remote endpoint type: string type: object UpdateEnvironmentObjectAirflowVariableOverridesRequest: properties: value: description: The value of the Airflow variable type: string type: object UpdateEnvironmentObjectConnectionOverridesRequest: properties: extra: description: Extra connection details, if any type: object host: description: The host address for the connection type: string login: description: The username used for the connection type: string password: description: The password used for the connection type: string port: description: The port for the connection type: integer schema: description: The schema for the connection type: string type: description: The type of connection type: string type: object UpdateEnvironmentObjectMetricsExportOverridesRequest: properties: authType: description: >- The type of authentication to use when connecting to the remote endpoint enum: - BASIC - AUTH_TOKEN type: string basicToken: description: The bearer token to connect to the remote endpoint type: string endpoint: description: The Prometheus endpoint where the metrics are exported type: string exporterType: description: The type of exporter enum: - PROMETHEUS type: string headers: additionalProperties: type: string description: >- Add key-value pairs to the HTTP request headers made by Astro when connecting to the remote endpoint type: object labels: additionalProperties: type: string description: >- Any key-value pair metrics labels for your export. You can use these to filter your metrics in downstream applications. type: object password: description: The password to connect to the remote endpoint type: string username: description: The username to connect to the remote endpoint type: string type: object ConnectionAuthTypeParameter: properties: airflowParamName: description: The name of the parameter in Airflow type: string dataType: description: The data type of the parameter type: string description: description: A description of the parameter type: string example: description: An example value for the parameter type: string friendlyName: description: The UI-friendly name for the parameter type: string isInExtra: description: Whether or not the parameter is included in the "extra" field type: boolean isRequired: description: Whether the parameter is required type: boolean isSecret: description: Whether the parameter is a secret type: boolean pattern: description: A regex pattern for the parameter type: string required: - airflowParamName - dataType - description - friendlyName - isInExtra - isRequired - isSecret type: object securitySchemes: JWT: scheme: bearer type: http ````