Platform API changelog

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

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.

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.

Summary

Added support for specifying authentication type when configuring metrics export 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

Summary

You can now create and update Airflow 3 Hosted Execution Deployments with the AstroExecutor via the Platform API.
You can now create and update Airflow 3 Remote Execution Deployments with the AstroExecutor via the Platform API.
Enable or disable 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.

Summary

Added the new productPlans property and OrganizationProductPlan schema to the Organization object.

Summary

Added new enums for the supportPlan property. To learn more about the different support plans available for Astro, see 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

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

Summary

Added the ability to work with Astro Alerts and their Notification Channels 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.

Summary

Added the new schema, bundle, as a deploy type for the Deploy endpoint, allowing you to use dbt deploys 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

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

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:

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.

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 for more information.

Added

The new EXTRA_LARGE value for schedulerSize attributes for creating, updating, and listing Deployments.

Summary

This update introduces new endpoints for managing IP access lists. See Astro IP access list documentation for more information.

Summary

This update introduces new endpoints for retrieving the health statuses your clusters. See Astro dedicated cluster documentation for more information.

Added

New object schemas:

ClusterHealthStatus
ClusterHealthStatusDetail

The endpoint GET organizations/:organizationId/clusters/:clusterId now includes the status, UPGRADE_PENDING.

The endpoint GET organizations/:organizationId/clusters/:clusterId now includes the status, ACCESS_DENIED.

Summary

This update introduces new endpoints for managing deploys, including image deploys, DAG deploys, and deploy rollbacks. See Astro documentation 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

The endpoint POST /organizations/{organizationId}/deployments now accepts an isDevelopmentMode query parameter

You can now make requests to the Roles endpoint to manage custom 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

Astro API v1beta1

Platform API

IAM API

Platform API changelog

Summary

Added

Changed

Summary

Added

Changed

Summary

Added

Summary

Added

Property Details

Summary

Added

Changed

Summary

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Summary

Added

Summary

Added

​Summary

​Added

​Changed

​Summary

​Added

​Changed

​Summary

​Added

​Summary

​Added

​Property Details

​Summary

​Added

​Changed

​Summary

​Summary

​Added

​Summary

​Added

​Summary

​Added

​Summary

​Added

​Summary

​Added

​Summary

​Added

​Summary

​Added

​Summary

​Summary

​Added

​Summary

​Added

Summary

Added

Changed

Summary

Added

Changed

Summary

Added

Summary

Added

Property Details

Summary

Added

Changed

Summary

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Added

Summary

Summary

Added

Summary

Added