Changelog

May 14, 2025

Summary

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

May 12, 2025

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
April 23, 2025

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
February 26, 2025

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.
December 10, 2024

Summary

Added the new schmea, 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
November 19, 2024

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.
November 13, 2024

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.
September 9, 2024

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.