Changelog

Summary

• Added lastRotatedAt to ApiToken so callers can see when a token was last rotated.
• Added a new git object (CreateDeployGitRequest on requests, DeployGit on responses) on CreateDeployRequest and Deploy for attaching git commit metadata to a deploy. A new GENERIC provider value (alongside GITHUB) supports non-GitHub remotes such as GitLab, Bitbucket, and self-hosted git via a remoteUrl field.
• Added IBM_ENTERPRISE as a value on OrganizationProductPlan.productPlanName.
• Narrowed Workspace.defaultCloudProvider from a free-form string to the enum AWS, AZURE, GCP.

Added

• Schemas

  • CreateDeployGitRequest and DeployGit: Git commit metadata associated with a deploy. Required: commitSha, provider. Optional: account, authorName, authorUrl, authorUsername, beforeCommitSha, branch, commitUrl, path, remoteUrl, repo. provider accepts GITHUB or GENERIC. For GITHUB, supply account and repo and leave remoteUrl empty. For GENERIC, supply remoteUrl and leave account and repo empty.

• Properties

  • ApiToken: lastRotatedAt (string, date-time). The time when the API token was last rotated.
  • CreateDeployRequest, Deploy: git (object). Git commit metadata for the deploy. See CreateDeployGitRequest and DeployGit.

• Enum values

  • OrganizationProductPlan.productPlanName: IBM_ENTERPRISE.

Changed

• Schemas
  • Workspace.defaultCloudProvider: Now restricted to the enum AWS, AZURE, GCP (previously a free-form string).

Summary

• Create Deployment requests now require only name and workspaceId. The server resolves infrastructure from Workspace defaults (or auto-selects when the Organization has a single non-shared cluster), infers the Deployment type from the resolved cluster, and applies defaults for runtime version, executor, scheduler size, and related fields. This reduces the create Deployment API from roughly 15 required fields down to 2.
• Added defaultClusterId, defaultCloudProvider, and defaultRegion on Workspace so Workspace admins can pre-configure target infrastructure for new Deployments. defaultClusterId is mutually exclusive with defaultCloudProvider and defaultRegion.
• Added GET /organizations/{organizationId}/deployments/{deploymentId}/logs and GET /users/self endpoints.
• Added hasAllowedIpAddressRanges and shouldEnforceDedicatedClusters as required properties on the Organization schema.
• Added workspaceId and deploymentId filters to GET /organizations/{organizationId}/teams.

Added

• Endpoints

  • GET /organizations/{organizationId}/deployments/{deploymentId}/logs: Get logs for an Astro Deployment. Supports filtering by log source (scheduler, triggerer, worker, webserver, dag-processor, apiserver), time range, text search, and pagination.
  • GET /users/self: Get the authenticated user’s profile, roles, invites, and feature flags. Supports an optional createIfNotExist query parameter.

• Schemas

  • CreateDeploymentInstanceSpecRequest
    • au: Integer. Astro unit allocation for the Deployment pod. Minimum 5, maximum 24. Optional.
    • replicas: Integer. Number of pod replicas. Minimum 1, maximum 4. Optional.
  • UpdateDeploymentInstanceSpecRequest
    • au: Integer. Astro unit allocation for the Deployment pod. Minimum 5, maximum 24. Required.
    • replicas: Integer. Number of pod replicas. Minimum 1, maximum 4. Required.
  • DeploymentLog
    • Required: limit, maxNumResults, offset, resultCount, results, searchId.
    • results: Array of DeploymentLogEntry.
  • DeploymentLogEntry
    • Required: raw (string), source (enum: scheduler, webserver, triggerer, worker, dag-processor, apiserver), timestamp (number).
  • SelfUser
    • Required: avatarUrl, createdAt, fullName, id, status, updatedAt, username.
    • Also includes featureFlags, invites, isIdpManaged, organizationId, and roles.
  • SelfUserFeatureFlag, SelfUserInvite, SelfUserRole, SelfUserRoleScope: Supporting schemas for SelfUser.
  • UpdateWorkerQueueRequest: Used by the workerQueues array on UpdateDedicatedDeploymentRequest, UpdateHybridDeploymentRequest, and UpdateStandardDeploymentRequest. Required fields: isDefault, maxWorkerCount, minWorkerCount, name, workerConcurrency.

• Properties

  • CreateWorkspaceRequest and UpdateWorkspaceRequest: defaultCloudProvider (enum: AWS, AZURE, GCP), defaultClusterId, and defaultRegion. Workspace admins use these fields to pre-configure target infrastructure for new Deployments. When a create Deployment request omits clusterId, cloudProvider, and region, the server uses these Workspace defaults. defaultClusterId is mutually exclusive with defaultCloudProvider and defaultRegion.
  • Organization: hasAllowedIpAddressRanges (boolean, required) indicating whether the Organization has at least one allowed IP address range configured, and shouldEnforceDedicatedClusters (boolean, required).
  • UpdateOrganizationRequest: shouldEnforceDedicatedClusters (boolean).
  • Workspace: defaultCloudProvider, defaultClusterId, and defaultRegion (strings) reflecting the configured defaults.

• Query parameters

  • GET /organizations/{organizationId}/teams: workspaceId and deploymentId filter the response to Teams with a role in the specified Workspace or Deployment.

Changed

• Removed required fields on create Deployment requests. When a field is omitted, the server applies a default. The only remaining required fields are name and workspaceId.

Summary

• Added new schemas for UserTeamMembership and UserTeamsPaginated to manage team memberships and pagination.
• Enhanced Cluster schema with new properties for Disaster Recovery (DR) support, including drRegion, isDrEnabled, and others.
• Introduced new permissions for managing environment objects and API tokens within organizations.
• Removed astroRuntimeVersion property from deployment update requests.
• Updated sorting options and descriptions for listing user teams within an organization.

Added

• Schemas:

  • UserTeamMembership
    • dagRoles: Array of DAG roles.
    • deploymentRoles: Array of deployment roles.
    • description: String, example: ‘My Team description’.
    • id: String, example: ‘clma5ftgk000008mhgev00k7d’.
    • isIdpManaged: Boolean, example: False.
    • name: String, example: ‘My Team’.
    • organizationRole: Enum with values like ‘ORGANIZATION_OWNER’, ‘ORGANIZATION_MEMBER’, etc.
    • rolesCount: Integer, example: 1.
    • workspaceRoles: Array of workspace roles.
  • UserTeamsPaginated
    • limit: Integer, example: 10.
    • offset: Integer, example: 0.
    • teams: Array of UserTeamMembership.
    • totalCount: Integer, example: 100.
  • Cluster
    • drRegion: String, example: ‘us-east-1’.
    • drSecondaryVpcCidr: String.
    • drVpcSubnetRange: String.
    • enableReplicationTimeControl: Boolean.
    • failoverInProgress: Boolean.
    • isDrEnabled: Boolean.
    • isFailedOver: Boolean.
  • CreateAwsClusterRequest, CreateAzureClusterRequest, CreateGcpClusterRequest
    • drRegion: String, example: ‘us-west-2’.
    • drSecondaryVpcCidr: String, example: ‘100.64.0.0/19’.
    • drVpcSubnetRange: String, example: ‘172.20.0.0/22’.
    • enableReplicationTimeControl: Boolean.
  • CreateDedicatedDeploymentRequest, CreateHybridDeploymentRequest, CreateStandardDeploymentRequest
    • drWorkloadIdentity: String, example: ‘arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0’.
  • Deployment
    • drExternalIPs: Array of strings.
    • drOidcIssuerUrl: String, example: ‘https://westus2.oic.prod-aks.azure.com/…’.
    • effectiveDRWorkloadIdentity: String.
  • UpdateDedicatedClusterRequest
    • enableDr: Boolean.
    • isFailedOver: Boolean.
  • UpdateDedicatedDeploymentRequest, UpdateHybridDeploymentRequest, UpdateStandardDeploymentRequest
    • drWorkloadIdentity: String.
    • environmentVariables: List of environment variables.

• Permissions:

  • /organizations/{organizationId}/environment-objects and related endpoints: organization.envObjects.access.
  • /organizations/{organizationId}/tokens and related endpoints: organization.apiTokens.access.
  • /organizations/{organizationId}/users/{userId}/roles: organization.userRoles.access.

Changed

• Schemas:

  • Cluster
    • secondaryVpcCidr description updated to “The secondary VPC CIDR. For AWS clusters only.”
    • Added drRegion, isDrEnabled, and name to required fields.
  • OrganizationProductPlan
    • Added ENTERPRISE_BUSINESS_CRITICAL to productPlanName enum.

• Endpoints:

  • /organizations/{organizationId}/users/{userId}/teams
    • Response schema changed from TeamsPaginated to UserTeamsPaginated.
    • Permission action changed from organization.users.get to organization.teams.get.
    • Updated descriptions for parameters and summary.

• Removed:

  • astroRuntimeVersion from UpdateDedicatedDeploymentRequest, UpdateHybridDeploymentRequest, and UpdateStandardDeploymentRequest.

Summary

• Added a new endpoint to list all Teams associated with a specific user.

Added

• Endpoints
  • GET /organizations/{organizationId}/users/{userId}/teams: List all Teams that a user belongs to within an Organization. Supports pagination with offset and limit query parameters, and sorting with the sorts query parameter.

Summary

• Added discriminators to CreateClusterRequest, CreateDeploymentRequest, UpdateClusterRequest, and UpdateDeploymentRequest schemas. Discriminators remove ambiguity when creating or updating resources by mapping requests to the correct cloud provider or Deployment type.
• Updated descriptions for ApiTokenRole and API token listing parameters.

Added

• CreateClusterRequest Schema:
  • Discriminator on cloudProvider with mappings for AWS, AZURE, and GCP.
• CreateDeploymentRequest Schema:
  • Discriminator on type with mappings for DEDICATED, HYBRID, and STANDARD.
• UpdateClusterRequest Schema:
  • Discriminator on clusterType with mappings for DEDICATED and HYBRID.
• UpdateDeploymentRequest Schema:
  • Discriminator on type with mappings for DEDICATED, HYBRID, and STANDARD.

Changed

• UpdateDedicatedDeploymentRequest, UpdateHybridDeploymentRequest, UpdateStandardDeploymentRequest Schemas:
  • Removed description for environmentVariables.
• ApiTokenRole Schema:
  • Updated description for entityId.
• API Token Listing Endpoint:
  • Updated description for the parameter related to DAG tags.

Summary

• Added new properties to the DagRole, Deployment, and Team schemas to enhance DAG access management.
• Introduced new query parameters for pagination and sorting in the /organizations/{organizationId}/tokens and /organizations/{organizationId}/users endpoints.

Added

• Schemas
  • DagRole
    • dagTag: DAG tag, required if DagId is not specified.
  • DeploymentEnvironmentVariable
    • updatedAt: Format set to date-time.
  • Invite
    • expiresAt: Format set to date-time.
  • Role
    • createdAt and updatedAt: Examples and format set to date-time.
  • RoleWithPermission
    • createdAt and updatedAt: Examples and format set to date-time.
  • Team
    • dagRoles: Array of DAG roles.
• Endpoints
  • /organizations/{organizationId}/tokens
    • limit: Limit for pagination.
    • sorts: Sorting criteria.
  • /organizations/{organizationId}/users
    • limit: Limit for pagination.
    • sorts: Sorting criteria.
• Enums
  • ApiTokenRole
    • entityType: Added DAG_TAG.

Initial release of the v1 Astro API.

See Migrate to v1 for key changes and migration steps.