> ## 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.

# Platform API changelog

<Update label="2026-04-02">
  ## Summary

  * Added Disaster Recovery (DR) support to various cluster and deployment schemas, including new properties for DR configuration.
  * Introduced new permissions for alert, environment object, and notification channel endpoints.
  * Updated `Cluster` schema with new status enum values and required properties for DR.
  * Modified `OrganizationProductPlan` schema with changes to the `astronomerProduct` enum values.

  ## Added

  * **Schemas and Properties:**
    * `Cluster`:
      * `drRegion`: Secondary region for DR.
      * `drSecondaryVpcCidr`: Secondary CIDR for DR region (AWS only).
      * `drVpcSubnetRange`: VPC subnet range for DR region (AWS only).
      * `enableReplicationTimeControl`: Boolean for S3 Replication Time Control.
      * `failoverInProgress`: Boolean indicating if failover is in progress.
      * `isDrEnabled`: Boolean indicating if DR is enabled.
      * `isFailedOver`: Boolean indicating if the cluster is failed over to DR region.
      * `secondaryVpcCidr`: Secondary CIDR for pod networking.
    * `CreateAlertRequest`:
      * `discriminator`: Property `type`.
    * `CreateAwsClusterRequest`:
      * `drRegion`, `drSecondaryVpcCidr`, `drVpcSubnetRange`, `enableReplicationTimeControl`, `secondaryVpcCidr`.
    * `CreateAzureClusterRequest`:
      * `drRegion`, `drVpcSubnetRange`.
    * `CreateClusterRequest`:
      * `discriminator`: Property `cloudProvider`.
    * `CreateDedicatedDeploymentRequest`:
      * `drWorkloadIdentity`: DR workload identity.
    * `CreateDeploymentRequest`:
      * `discriminator`: Property `type`.
    * `CreateGcpClusterRequest`:
      * `drRegion`, `drVpcSubnetRange`.
    * `CreateHybridDeploymentRequest`:
      * `drWorkloadIdentity`.
    * `CreateNotificationChannelRequest`:
      * `discriminator`: Property `type`.
    * `CreateStandardDeploymentRequest`:
      * `drWorkloadIdentity`.
    * `Deployment`:
      * `drExternalIPs`: List of external IPs in DR cluster.
      * `drOidcIssuerUrl`: OIDC issuer URL for DR cluster.
      * `drWorkloadIdentity`.
    * `UpdateAlertRequest`:
      * `discriminator`: Property `type`.
    * `UpdateClusterRequest`:
      * `discriminator`: Property `clusterType`.
    * `UpdateDedicatedClusterRequest`:
      * `enableDr`: Boolean to enable/disable DR.
      * `isFailedOver`: Boolean to trigger DR failover.
    * `UpdateDedicatedDeploymentRequest`:
      * `drWorkloadIdentity`.
    * `UpdateDeploymentRequest`:
      * `discriminator`: Property `type`.
    * `UpdateHybridDeploymentRequest`:
      * `drWorkloadIdentity`.
    * `UpdateNotificationChannelRequest`:
      * `discriminator`: Property `type`.
    * `UpdateStandardDeploymentRequest`:
      * `drWorkloadIdentity`.

  * **Endpoints:**
    * Added `x-permission` for alert, environment object, and notification channel endpoints.

  * **Enums:**
    * `Cluster.status`: Added `FAILING_OVER`, `FAILOVER_FAILED`.
    * `Organization.supportPlan`: Added `ENTERPRISE_BUSINESS_CRITICAL`.
    * `OrganizationProductPlan.astronomerProduct`: Added `OBSERVE`.

  ## Changed

  * **Schemas:**
    * `Cluster`:
      * Removed description from `vpcSubnetRange`.
      * Added `drRegion` and `isDrEnabled` to required properties.
    * `OrganizationProductPlan`:
      * Changed `astronomerProduct` enum value from `"ASTRO OBSERVE"` to `"ASTRO"`.
</Update>

<Update label="2025-09-17">
  ## Summary

  * Added a new `pattern` property to the `ConnectionAuthTypeParameter` schema, which specifies a regex pattern for the parameter.
  * Introduced a new enum value `SNOWFLAKE_MARKETPLACE` to the `paymentMethod` property of the `Organization` schema.

  ## Added

  * **`ConnectionAuthTypeParameter` Schema**
    * `pattern`: A new property with a description "A regex pattern for the parameter" and type `string`.
  * **`Organization` Schema**
    * `paymentMethod` Enum
      * `SNOWFLAKE_MARKETPLACE`: Added as a new payment method option.

  ## Changed

  * No changes were made to existing objects, schemas, fields, endpoints, or enum values.
</Update>

<Update label="2025-07-30">
  ## Summary

  * Added new properties `apiUrl` and `uiUrl` to the `Deployment` schema, providing URLs for accessing the Airflow API and UI respectively. For Airflow 2, the `apiUrl` and `uiUrl` point to the webserver. For Airflow 3 Deployments, these point to the API server.
  * Updated the `Deployment` schema to require the `apiUrl` and `uiUrl` properties.

  ## Added

  * New properties in the `Deployment` schema:
    * `apiUrl`:
      * Description: The base URL to directly access the Airflow API.
    * `uiUrl`:
      * Description: The URL to access the Airflow UI.
</Update>

<Update label="2025-07-14">
  ## Summary

  * Added support for specifying authentication type when [configuring metrics export](/docs/astro/export-metrics) settings for environments and environment objects.

  ## Added

  * New `authType` property added to the following schema objects to define the type of authentication used when connecting to a remote endpoint for metrics export from Astro:
    * `EnvironmentObjectMetricsExport`
    * `EnvironmentObjectMetricsExportOverrides`
    * `CreateEnvironmentObjectMetricsExportRequest`
    * `UpdateEnvironmentObjectMetricsExportRequest`
    * `UpdateEnvironmentObjectMetricsExportOverridesRequest`

  ### Property Details

  * `authType`: Defines the type of authentication to use when connecting to the remote endpoint.
    * Supported values:
      * `BASIC`
      * `AUTH_TOKEN`
</Update>

<Update label="2025-06-30">
  ## Summary

  * You can now create and update [Airflow 3 Hosted Execution Deployments](/docs/astro/execution-mode#hosted-execution) with the `AstroExecutor` via the Platform API.
  * You can now create and update [Airflow 3 Remote Execution Deployments](/docs/astro/execution-mode#remote-execution) with the `AstroExecutor` via the Platform API.
  * Enable or disable [Enhanced Support Access](/docs/astro/user-permissions#enhanced-support-access) for your `Organization` API endpoints.

  ## Added

  * New properties to support creating and updating Remote Execution Deployments on Astro:
    * `DeploymentRemoteExecution`
    * `DeploymentRemoteExecutionRequest`
  * New ENUMs for executor types were added to the `executor` property to support creating Hosted execution Deployments:
    * `Astro`
  * Date-time and format examples for the following properties:
    * `createdAt`
    * `updatedAt`

  ## Changed

  * In `/organizations/{organizationId}/alerts`, removed the `ORGANIZATION` and `WORKSPACE` ENUMs that you can use to search within the `entityType` for the `PatternMatchRequest` object.
</Update>

<Update label="2025-05-14">
  ## Summary

  Added the new `productPlans` property and `OrganizationProductPlan` schema to the `Organization` object.
</Update>

<Update label="2025-05-12">
  ## Summary

  Added new enums for the [`supportPlan`](https://www.astronomer.io/docs/api/platform-api-reference/get-organization#response.body.supportPlan) property. To learn more about the different support plans available for Astro, see [Pricing](https://www.astronomer.io/pricing/).

  ## Added

  The new enums include the following:

  * `INACTIVE`
  * `INTERNAL`
  * `POV`
  * `BASIC_PAYGO`
  * `TEAM_PAYGO`
  * `BUSINESS`
  * `TEAM`
  * `ENTERPRISE`
  * `DEVELOPER`
  * `DEVELOPER_PAYGO`
  * `TEAM_V2`
  * `BUSINESS_V2`
  * `ENTERPRISE_V2`
  * `TRIAL_V2`
</Update>

<Update label="2025-04-23">
  ## Summary

  Added the `PatternMatchRequest` object, and changed the schema name of `PatternMatch` to `PatternMatchRequest` for `alerts` object properties when working with alerts rules.

  ## Added

  Added the `PatternMatchRequest` object, which includes the following properties:

  * `entityType`
  * `operatorType`
  * `values`

  Changed the schema name of `PatternMatch` to `PatternMatchRequest` for the following `alerts` objects:

  * `CreateDagDurationAlertRules`
  * `CreateDagFailureAlertRules`
  * `CreateDagSuccessAlertRules`
  * `CreateDagTimelinessAlertRules`
  * `CreateTaskDurationAlertRules`
  * `CreateTaskFailureAlertRules`
  * `UpdateDagDurationAlertRules`
  * `UpdateDagFailureAlertRules`
  * `UpdateDagSuccessAlertRules`
  * `UpdateDagTimelinessAlertRules`
  * `UpdateTaskDurationAlertRules`
  * `UpdateTaskFailureAlertRules`
</Update>

<Update label="2025-02-26">
  ## Summary

  Added the ability to work with [Astro Alerts](/docs/astro/alerts) and their [Notification Channels](/docs/astro/alerts#notification-channels-scope) through the Astro API, with the new `alerts` and `notification-channels` endpoints.

  ### Added

  New endpoints:

  * `GET /organizations/{organizationId}/alerts` to list Alerts in a Workspace or Deployment.
  * `POST /organizations/{organizationId}/alerts` to create an Alert for a Deployment or Workspace.
  * `GET /organizations/{organizationId}/alerts/{alertId}` to retrieve details about a specific Alert.
  * `POST /organizations/{organizationId}/alerts/{alertId}` to update an existing Alert.
  * `DEL /organizations/{organizationId}/alerts/{alertId}` to delete an Alert.
  * `GET /organizations/{organizationId}/notification-channels` to list Alert Notification Channels.
  * `POST /organizations/{organizationId}/notification-channels` to create an Alert Notification Channel.
  * `GET /organizations/{organizationId}/alerts/{notificationChannelId}` to retrieve details about a specific Alert Notification Channel.
  * `POST /organizations/{organizationId}/alerts/{notificationChannelId}` to update an existing Alert Notification Channel.
  * `DEL /organizations/{organizationId}/alerts/{notificationChannelId}` to delete an Alert Notification Channel.
</Update>

<Update label="2024-12-10">
  ## Summary

  Added the new schema, `bundle`, as a deploy type for the Deploy endpoint, allowing you to use [dbt deploys](/docs/astro/deploy-dbt-project#option-2) via the Astro API.

  ## Added

  New object schema for the `Deploy` object at `/organizations/{organizationId}/deployments/{deploymentId}/deploys`:

  * `Bundle`

  Which includes the following new properties:

  * `bundleType`
  * `currentVersion`
  * `deployId`
  * `desiredVersion`
  * `mountPath`

  New properties are also added to the following endpoints:

  * `POST organizations/{organizationId}/deployments/{deploymentId}/deploys`
    * `bundleMountPath`
    * `bundleType`

  * `GET organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}`
    * `bundleMountPath`
    * `bundleUploadUrl`
    * `bundles`

  * `POST organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}/finalize`:
    * `bundleTarballVersion`
</Update>

<Update label="2024-11-19">
  ## Summary

  Added the ability to retrieve audit logs using the Astro API call, `GET /organizations/{organizationId}/audit-logs`. You can also use the parameters `startDate` and `endDate` to limit the number of logs you retrieve to a particular timescale.

  See [Audit logs reference](/docs/astro/audit-logs#audit-logs-reference) for more information.

  ### Added

  * `GET /organizations/{organizationId}/audit-logs` - to retrieve audit logs via the API. Note that this API call has a non-configurable rate limit of `2` per minute.
</Update>

<Update label="2024-11-13">
  ## Summary

  Added the ability to work with the Astro Environment Manager through the Astro API, with the new `environment-objects` endpoint. Environment Objects are the API representation of the different functionalities the Environment Manager supports such as Universal Metrics Export, Airflow Variables, and Connections.

  To learn more about the different Astro Environment Manger functionality, which you can now access using the Astro API, see:

  * [Manage connections and variables](/docs/astro/manage-connections-variables)
  * [Create Airflow connections in the Astro UI](/docs/astro/create-and-link-connections)
  * [Create Airflow variables in the Astro UI](/docs/astro/create-and-link-variables)
  * [Export metrics from Astro](/docs/astro/export-metrics)

  ### Added

  * `GET /organizations/{organizationId}/environment-objects` to list environment objects in a Workspace or Deployment.
  * `POST /organizations/{organizationId}/environment-objects` to create an environment object for a Deployment or Workspace.
  * `GET /organizations/{organizationId}/environment-objects/{environmentObjectId}` to retrieve details about a specific environment object.
  * `POST /organizations/{organizationId}/environment-objects/{environmentObjectId}` to update an existing Deployment-level or Workspace-level environment object.
  * `DEL /organizations/{organizationId}/environment-objects/{environmentObjectId}` to delete an environment object from a Deployment or Workspace.
  * `POST /organizations/{organizationId}/environment-objects/{environmentObjectId}/exclude-linking` to exclude a specific Deployment from linking to an environment object created at the Workspace level.
</Update>

<Update label="2024-09-09">
  ## Summary

  This update introduces new possible values for using the Extra Large scheduler size for the `https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments` endpoint. This scheduler size includes the new separate DAG Processor, which improves scheduler performance and reliability. See [Scheduler](/docs/astro/deployment-resources#scheduler) for more information.

  ### Added

  The new `EXTRA_LARGE` value for `schedulerSize` attributes for creating, updating, and listing Deployments.
</Update>

<Update label="2024-07-31">
  ## Summary

  This update introduces new endpoints for managing IP access lists. See [Astro IP access list documentation](/docs/astro/ip-access-list) for more information.
</Update>

<Update label="2024-07-10">
  ## Summary

  This update introduces new endpoints for retrieving the health statuses your clusters. See [Astro dedicated cluster documentation](/docs/astro/create-dedicated-cluster) for more information.

  ### Added

  New object schemas:

  * `ClusterHealthStatus`
  * `ClusterHealthStatusDetail`
</Update>

<Update label="2024-06-18">
  * The endpoint `GET organizations/:organizationId/clusters/:clusterId` now includes the status, `UPGRADE_PENDING`.
</Update>

<Update label="2024-06-11">
  * The endpoint `GET organizations/:organizationId/clusters/:clusterId` now includes the status, `ACCESS_DENIED`.
</Update>

<Update label="2024-05-15">
  ## Summary

  This update introduces new endpoints for managing deploys, including image deploys, DAG deploys, and deploy rollbacks. See [Astro documentation](https://docs.astronomer.io/astro/deploy-code) for more information.

  ### Added

  New endpoints:

  * `GET /organizations/{organizationId}/deployments/{deploymentId}/deploys` to list deploys for a deployment.
  * `POST /organizations/{organizationId}/deployments/{deploymentId}/deploys` to create a new deploy.
  * `GET /organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}` to retrieve a specific deploy.
  * `POST /organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}` to update an existing deploy.
  * `POST /organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}/finalize` to finalize a deploy.
  * `POST /organizations/{organizationId}/deployments/{deploymentId}/deploys/{deployId}/rollback` to roll back a deploy.

  New object schemas:

  * `CreateDeployRequest`
  * `Deploy`
  * `DeploysPaginated`
  * `FinalizeDeployRequest`
  * `UpdateDeployRequest`
  * `DeployRollbackRequest`
</Update>

<Update label="2024-04-23">
  * The endpoint `POST /organizations/{organizationId}/deployments` now accepts an `isDevelopmentMode` query parameter
</Update>

<Update label="2024-04-12">
  * You can now make requests to the [`Roles` endpoint](https://www.astronomer.io/docs/api/iam-api-reference/role/list-role-templates) to manage [custom roles](/docs/astro/customize-deployment-roles) in your Organization.
  * The endpoint `GET /organizations/{organizationId}/clusters` now accepts a `names` query parameter
  * The endpoint `GET /organizations/{organizationId}/deploymentss` now accepts a `names` query parameter
  * The endpoint `GET /organizations/{organizationId}/workspaces` now accepts a `names` query parameter
</Update>