> ## 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 a Deployment > Update a Deployment in the Organization. ## OpenAPI ````yaml /astro/api/v-1/openapi.yaml post /organizations/{organizationId}/deployments/{deploymentId} openapi: 3.0.3 info: contact: {} description: Astro Platform API title: Astro Platform API version: v1.0 servers: - url: https://api.astronomer.io/v1 security: - JWT: [] tags: - 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 `deployment` object represents an Astro Deployment, which is a hosted Airflow environment that is powered by all core Airflow components, including schedulers and workers. Make requests to the `deployment` object to create, update, or delete a Deployment or its computational resources. See [Deployment settings](https://astronomer.io/docs/astro/deployment-settings). name: Deployment - 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 `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 - description: >- The `user` object represents a user account in your Astro Organization. Astro creates a new `user` object whenever you invite a user by email or add a user to Astro through an identity provider. The object contains all information about a user, including their personal information, roles, and login attempts. It doesn't include attributes for actions that the user completes after they log in, such as updating a Deployment. Make requests to `user` endpoints to manage permissions for existing users both at the Organization and Workspace level. To create new users, make requests to `invite` endpoints instead. name: User - description: >- The `team` object represents an Astro Team, which is a group of users that share the same permissions across your Organization and Workspaces. Make requests to `team` endpoints to create, update, and delete Teams across an Organization. See [Configure Teams on Astro](https://astronomer.io/docs/astro/manage-teams). name: Team - description: >- The `apitoken` object represents a single API token within your Organization. API tokens are used to authenticate automated tools and processes to your Organization. They have varying levels of access to your resources based on their Organization, Workspace, and Deployment roles. See [Workspace API tokens](workspace-api-tokens.md) and [Organization API tokens](organization-api-tokens.md). name: api-token x-group: API Token - name: allowed-ip-address-range x-group: Allowed IP Address Range - name: agent-token x-group: Agent Token paths: /organizations/{organizationId}/deployments/{deploymentId}: post: tags: - Deployment summary: Update a Deployment description: Update a Deployment in the Organization. operationId: UpdateDeployment parameters: - description: The ID of the Organization to which the Deployment belongs. in: path name: organizationId required: true schema: type: string - description: The Deployment's ID. in: path name: deploymentId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeploymentRequest' description: The request body for updating a Deployment. required: true x-originalParamName: body responses: '200': content: application/json: schema: $ref: '#/components/schemas/Deployment' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad Request '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 '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal Server Error security: - JWT: [] components: schemas: UpdateDeploymentRequest: discriminator: mapping: DEDICATED: $ref: '#/components/schemas/UpdateDedicatedDeploymentRequest' HYBRID: $ref: '#/components/schemas/UpdateHybridDeploymentRequest' STANDARD: $ref: '#/components/schemas/UpdateStandardDeploymentRequest' propertyName: type oneOf: - $ref: '#/components/schemas/UpdateDedicatedDeploymentRequest' - $ref: '#/components/schemas/UpdateHybridDeploymentRequest' - $ref: '#/components/schemas/UpdateStandardDeploymentRequest' type: object Deployment: properties: airflowVersion: description: The Deployment's Airflow version. example: 2.7.2, if airflow version is not found, it will return NA type: string apiUrl: description: The base URL to directly access the Airflow API. example: https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed/api/v1 type: string astroRuntimeVersion: description: The Deployment's Astro Runtime version. example: 9.1.0 type: string cloudProvider: description: The cloud provider of the cluster. Only for Standard Deployment. enum: - AWS - AZURE - GCP example: AZURE type: string clusterId: description: The ID of the cluster where the Deployment is hosted. example: clmh597sg000208lb2kjhcn8q type: string clusterName: description: >- The name of the cluster where the Deployment is hosted. Only for Dedicated and Hybrid Deployments. example: my cluster type: string contactEmails: description: The list of contact emails for the Deployment. example: - user1@company.com items: type: string type: array createdAt: description: >- The time when the Deployment was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string createdBy: $ref: '#/components/schemas/BasicSubjectProfile' dagTarballVersion: description: >- The Deployment's current DAG tarball version, also known as the Bundle Version in the Astro UI. If no deploys are currently processing, this value should be the same as DesiredDagTarballVersion. example: '2024-01-12T18:32:20.5898930Z' type: string defaultTaskPodCpu: description: >- The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores. example: '0.5' type: string defaultTaskPodMemory: description: >- The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi`. This value must always be twice the value of `DefaultTaskPodCpu`. example: 1Gi type: string description: description: The Deployment's description. example: My deployment description type: string desiredDagTarballVersion: description: >- The Deployment's expected DAG tarball version after a currently processing deploy completes. This value is updated when a user triggers a DAG-only deploy to indicate that the Deployment is expecting a new DAG tarball version. If no deploys are currently processing, this value should be the same as DagTarballVersion. example: '2024-01-12T18:32:20.5898930Z' type: string drExternalIPs: description: A list of the Deployment's external IPs in the DR cluster items: type: string type: array drOidcIssuerUrl: description: OIDC issuer URL of the deployment's DR cluster example: >- https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/ type: string effectiveDRWorkloadIdentity: description: >- The DR workload identity being used by the deployment. Either user-configured or Astronomer-provided default. type: string effectiveWorkloadIdentity: description: >- The workload identity being used by the deployment. Either user-configured or Astronomer-provided default. type: string environmentVariables: description: >- The Deployment's environment variables. Secret values will be omitted from response. items: $ref: '#/components/schemas/DeploymentEnvironmentVariable' type: array executor: description: The Deployment's executor type. enum: - CELERY - KUBERNETES - ASTRO example: CELERY type: string externalIPs: description: A list of the Deployment's external IPs. example: - 0.0.0.0 items: type: string type: array id: description: The Deployment's ID. example: clmh57jtm000008lb58fe2wmv type: string imageRepository: description: The URL of the Deployment's image repository. example: https://my-image-repository type: string imageTag: description: >- The Deployment's custom image tag. Appears only if specified in the most recent deploy. example: my-image-tag type: string imageVersion: description: >- A tag that Astronomer applies to the Deployment's Astro Runtime image during a deploy. It includes the date and time of the deploy. example: deploy-2023-09-14T19-04 type: string isCicdEnforced: description: >- Whether the Deployment requires that all deploys are made through CI/CD. example: true type: boolean isDagDeployEnabled: description: Whether the Deployment has DAG deploys enabled. example: true type: boolean isDevelopmentMode: description: >- If true, deployment will be able to use development-only features, such as hibernation, but will not have guaranteed uptime SLAs type: boolean isHighAvailability: description: >- Whether the Deployment has high availability (HA) enabled. If `true`, multiple scheduler Pods will run at once. example: true type: boolean name: description: The Deployment's name. example: My deployment type: string namespace: description: The Deployment's namespace name in the Kubernetes cluster. example: weightless-diameter-8927 type: string oidcIssuerUrl: description: OIDC issuer URL of the deployment's cluster example: >- https://westus2.oic.prod-aks.azure.com/b84efac8-cfee-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/ type: string organizationId: description: The ID of the Organization to which the Deployment belongs. example: clmh59gt0000308lbgswe5fvh type: string region: description: >- The region of the cluster. Only for Dedicated and Hybrid Deployments. example: us-east-1 type: string remoteExecution: $ref: '#/components/schemas/DeploymentRemoteExecution' resourceQuotaCpu: description: >- The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores. example: '160' type: string resourceQuotaMemory: description: >- The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi`. This value must always be twice the value of `ResourceQuotaCpu`. example: 320Gi type: string runtimeVersion: description: >- Deprecated: runtimeVersion has been replaced with astroRuntimeVersion example: 9.1.0 type: string scalingSpec: $ref: '#/components/schemas/DeploymentScalingSpec' scalingStatus: $ref: '#/components/schemas/DeploymentScalingStatus' schedulerAu: description: >- The number of Astronomer units (AU) for the Deployment's scheduler. Applies only to Deployments hosted on Hybrid clusters. example: 5 type: integer schedulerCpu: description: >- The CPU limit for the Deployment's scheduler. Specified in number of CPU cores. example: '1' type: string schedulerMemory: description: >- The memory limit for the Deployment's scheduler. Units in Gibibytes or `Gi`. example: 1Gi type: string schedulerReplicas: description: The number of schedulers to use in the Deployment. example: 1 type: integer schedulerSize: description: The Deployment's scheduler size. enum: - SMALL - MEDIUM - LARGE - EXTRA_LARGE example: MEDIUM type: string status: description: The status of the Deployment. enum: - CREATING - DEPLOYING - HEALTHY - UNHEALTHY - UNKNOWN - HIBERNATING example: HEALTHY type: string statusReason: description: A message that provides context for the Deployment's status. example: Successfully Deployed type: string taskPodNodePoolId: description: The node pool ID for the task pod. example: clmh5mash000008mia6lnbs0f type: string type: description: The type of cluster that the Deployment runs on. enum: - DEDICATED - HYBRID - STANDARD example: DEDICATED type: string uiUrl: description: The URL to access the Airflow UI. example: >- https://clypw7uah05jb01nwtpojz0j2.astronomer.run/d4yjo9ed?orgId=org_bvqayGttQauxdxB2 type: string updatedAt: description: >- The time when the Deployment was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string updatedBy: $ref: '#/components/schemas/BasicSubjectProfile' webServerAirflowApiUrl: description: >- The Deployment's webserver's base url to directly access the Airflow api. example: myorganization.astronomer-dev.run/d8fe2wmv/api/v1 type: string webServerCpu: description: >- The CPU limit for the Deployment's webserver. Units are in number of CPU cores. example: '0.5' type: string webServerIngressHostname: description: The Deployment's webserver's ingress hostname. example: clmh597sg000208lb2kjhcn8q.astronomer.run/d8fe2wmv type: string webServerMemory: description: >- The memory limit for the Deployment's webserver. Units in Gibibytes or `Gi`. example: 0.5Gi type: string webServerReplicas: description: The number of webserver replicas. example: 1 type: integer webServerUrl: description: The Deployment's webserver's url. example: >- myorganization.astronomer-dev.run/d8fe2wmv?orgId=org_edxLzpFcLrgEfpD5 type: string workerQueues: description: A list of the Deployment's worker queues. items: $ref: '#/components/schemas/WorkerQueue' type: array workspaceId: description: The ID of the Workspace to which the Deployment belongs. example: clmh58o7d000108lb74ktc9o64 type: string workspaceName: description: The name of the Workspace to which the Deployment belongs. example: my-workspace type: string required: - airflowVersion - apiUrl - astroRuntimeVersion - createdAt - createdBy - id - imageRepository - imageTag - isCicdEnforced - isDagDeployEnabled - name - namespace - organizationId - runtimeVersion - schedulerCpu - schedulerMemory - schedulerReplicas - status - uiUrl - updatedAt - updatedBy - webServerAirflowApiUrl - webServerCpu - webServerIngressHostname - webServerMemory - webServerUrl - workspaceId type: object Error: properties: fieldErrors: description: >- FieldErrors carries one entry per failed request-validation constraint. Only present on 400 responses caused by request binding/validation. items: $ref: '#/components/schemas/FieldValidationError' type: array message: type: string requestId: type: string statusCode: maximum: 600 minimum: 400 type: integer required: - message - requestId - statusCode type: object UpdateDedicatedDeploymentRequest: title: DEDICATED properties: contactEmails: description: A list of contact emails for the Deployment. example: - user1@company.com items: type: string type: array defaultTaskPodCpu: description: >- The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores. Required if Remote Execution is disabled. example: '0.5' type: string defaultTaskPodMemory: description: >- The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `DefaultTaskPodCpu`. Required if Remote Execution is disabled. example: 1Gi type: string description: description: The Deployment's description. example: My deployment description maxLength: 1000 type: string drWorkloadIdentity: description: The Deployment's DR workload identity. example: arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0 type: string environmentVariables: description: List of environment variables to add to the Deployment. items: $ref: '#/components/schemas/DeploymentEnvironmentVariableRequest' type: array executor: description: The Deployment's executor type. enum: - CELERY - KUBERNETES - ASTRO example: CELERY type: string isCicdEnforced: description: >- Whether the Deployment requires that all deploys are made through CI/CD. example: true type: boolean isDagDeployEnabled: description: Whether the Deployment has DAG deploys enabled. example: true type: boolean isDevelopmentMode: description: >- Whether the Deployment is for development only. If `false`, the Deployment can be considered production for the purposes of support case priority, but development-only features such as hibernation will not be available. You can't update this value to `true` for existing non-development Deployments. type: boolean isHighAvailability: description: >- Whether the Deployment is configured for high availability. If `true`, multiple scheduler pods will be online. example: true type: boolean name: description: The Deployment's name. example: My deployment maxLength: 500 type: string remoteExecution: $ref: '#/components/schemas/DeploymentRemoteExecutionRequest' resourceQuotaCpu: description: >- The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores. Required if Remote Execution is disabled. example: '160' type: string resourceQuotaMemory: description: >- The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `ResourceQuotaCpu`. Required if Remote Execution is disabled. example: 320Gi type: string scalingSpec: $ref: '#/components/schemas/DeploymentScalingSpecRequest' schedulerSize: description: The size of the scheduler Pod. enum: - SMALL - MEDIUM - LARGE - EXTRA_LARGE example: MEDIUM type: string type: description: The type of the Deployment. enum: - DEDICATED - HYBRID - STANDARD example: DEDICATED type: string workerQueues: description: >- A list of the Deployment's worker queues. Applies only when `Executor` is `CELERY` or if Remote Execution is disabled and executor is `ASTRO`. All these Deployments need at least 1 worker queue called `default`. items: $ref: '#/components/schemas/UpdateWorkerQueueRequest' minItems: 1 type: array workloadIdentity: description: The Deployment's workload identity. example: arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0 type: string workspaceId: description: The ID of the Workspace to which the Deployment belongs. example: clmh7vdf4000008lhhlnk9t6o type: string required: - environmentVariables - executor - isCicdEnforced - isDagDeployEnabled - isHighAvailability - name - schedulerSize - type - workspaceId type: object UpdateHybridDeploymentRequest: title: HYBRID properties: contactEmails: description: A list of contact emails for the Deployment. example: - user1@company.com items: type: string type: array description: description: The Deployment's description. example: My deployment description maxLength: 1000 type: string drWorkloadIdentity: description: The Deployment's DR workload identity. example: arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0 type: string environmentVariables: description: List of environment variables to add to the Deployment. items: $ref: '#/components/schemas/DeploymentEnvironmentVariableRequest' type: array executor: description: The Deployment's executor type. enum: - CELERY - KUBERNETES example: CELERY type: string isCicdEnforced: description: >- Whether the Deployment requires that all deploys are made through CI/CD. example: true type: boolean isDagDeployEnabled: description: Whether the Deployment has DAG deploys enabled. example: true type: boolean name: description: The Deployment's name. example: My deployment maxLength: 500 type: string scheduler: $ref: '#/components/schemas/UpdateDeploymentInstanceSpecRequest' taskPodNodePoolId: description: >- The node pool ID for worker Pods. Applies only when `Executor` is `KUBERNETES`. example: clmh87air000008mgfkgrg9fy type: string type: description: The type of the Deployment. enum: - DEDICATED - HYBRID - STANDARD example: DEDICATED type: string workerQueues: description: >- The list of worker queues configured for the Deployment. Applies only when `Executor` is `CELERY`. All Deployments need at least 1 worker queue called `default`. items: $ref: '#/components/schemas/UpdateWorkerQueueRequest' minItems: 1 type: array workloadIdentity: description: The Deployment's workload identity. example: arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0 type: string workspaceId: description: The ID of the Workspace to which the Deployment belongs. example: clmh7vdf4000008lhhlnk9t6o type: string required: - environmentVariables - executor - isCicdEnforced - isDagDeployEnabled - name - scheduler - type - workspaceId type: object UpdateStandardDeploymentRequest: title: STANDARD properties: contactEmails: description: A list of contact emails for the Deployment. example: - user1@company.com items: type: string type: array defaultTaskPodCpu: description: >- The default CPU resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in number of CPU cores. Required if Remote Execution is disabled. example: '0.5' type: string defaultTaskPodMemory: description: >- The default memory resource usage for a worker Pod when running the Kubernetes executor or KubernetesPodOperator. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `DefaultTaskPodCpu`. Required if Remote Execution is disabled. example: 1Gi type: string description: description: The Deployment's description. example: My deployment description maxLength: 1000 type: string drWorkloadIdentity: description: The Deployment's DR workload identity. example: arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0 type: string environmentVariables: description: List of environment variables to add to the Deployment. items: $ref: '#/components/schemas/DeploymentEnvironmentVariableRequest' type: array executor: description: The Deployment's executor type. enum: - CELERY - KUBERNETES - ASTRO example: CELERY type: string isCicdEnforced: description: >- Whether the Deployment requires that all deploys are made through CI/CD. example: true type: boolean isDagDeployEnabled: description: Whether the Deployment has DAG deploys enabled. example: true type: boolean isDevelopmentMode: description: >- Whether the Deployment is for development only. If `false`, the Deployment can be considered production for the purposes of support case priority, but development-only features such as hibernation will not be available. You can't update this value to `true` for existing non-development Deployments. type: boolean isHighAvailability: description: >- Whether the Deployment is configured for high availability. If `true`, multiple scheduler pods will be online. example: true type: boolean name: description: The Deployment's name. example: My deployment maxLength: 500 type: string remoteExecution: $ref: '#/components/schemas/DeploymentRemoteExecutionRequest' resourceQuotaCpu: description: >- The CPU quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current CPU usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in number of CPU cores. Required if Remote Execution is disabled. example: '160' type: string resourceQuotaMemory: description: >- The memory quota for worker Pods when running the Kubernetes executor or KubernetesPodOperator. If current memory usage across all workers exceeds the quota, no new worker Pods can be scheduled. Units are in `Gi` and must be explicitly included. This value must always be twice the value of `ResourceQuotaCpu`. Required if Remote Execution is disabled. example: 320Gi type: string scalingSpec: $ref: '#/components/schemas/DeploymentScalingSpecRequest' schedulerSize: description: The size of the scheduler Pod. enum: - SMALL - MEDIUM - LARGE - EXTRA_LARGE example: MEDIUM type: string type: description: The type of the Deployment. enum: - DEDICATED - HYBRID - STANDARD example: DEDICATED type: string workerQueues: description: >- A list of the Deployment's worker queues. Applies only when `Executor` is `CELERY` or if Remote Execution is disabled and executor is `ASTRO`. All these Deployments need at least 1 worker queue called `default`. items: $ref: '#/components/schemas/UpdateWorkerQueueRequest' minItems: 1 type: array workloadIdentity: description: The Deployment's workload identity. example: arn:aws:iam::123456789:role/AirflowS3Logs-clmk2qqia000008mhff3ndjr0 type: string workspaceId: description: The ID of the Workspace to which the Deployment belongs. example: clmh7vdf4000008lhhlnk9t6o type: string required: - environmentVariables - executor - isCicdEnforced - isDagDeployEnabled - isHighAvailability - name - schedulerSize - type - workspaceId 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 DeploymentEnvironmentVariable: properties: isSecret: description: Whether the environment variable is a secret. example: true type: boolean key: description: The environment variable key, used to call the value in code. example: my-var type: string updatedAt: description: >- The time when the environment variable was last updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string value: description: The environment variable value. example: my-var-value type: string required: - isSecret - key - updatedAt type: object DeploymentRemoteExecution: properties: allowedIpAddressRanges: items: type: string type: array enabled: type: boolean remoteApiUrl: type: string taskLogBucket: type: string taskLogUrlPattern: type: string required: - allowedIpAddressRanges - enabled - remoteApiUrl type: object DeploymentScalingSpec: properties: hibernationSpec: $ref: '#/components/schemas/DeploymentHibernationSpec' type: object DeploymentScalingStatus: properties: hibernationStatus: $ref: '#/components/schemas/DeploymentHibernationStatus' type: object WorkerQueue: properties: astroMachine: description: >- The Astro machine size for each worker node in the queue. For Astro Hosted only. example: A5 type: string id: description: The worker queue's ID. example: clmh9vsuf000908midngba9mw type: string isDefault: description: >- Whether the worker queue is the default worker queue in the Deployment. example: true type: boolean maxWorkerCount: description: The maximum number of workers that can run at once. example: 10 type: integer minWorkerCount: description: The minimum number of workers running at once. example: 1 type: integer name: description: The worker queue's name. example: default type: string nodePoolId: description: The node pool ID associated with the worker queue. example: clmh9yjcn000a08mi8dsgbno9 type: string podCpu: description: >- The maximum number of CPU units available for a worker node. Units are in number of CPU cores. example: '1' type: string podEphemeralStorage: description: >- The ephemeral storage limit for each worker Pod. Units are in Gibibytes or `Gi`. example: 10Gi type: string podMemory: description: >- The maximum amount of memory available for a worker node. Units are in Gibibytes or `Gi`. example: 2Gi type: string workerConcurrency: description: >- The maximum number of concurrent tasks that a worker Pod can run at a time. example: 20 type: integer required: - id - isDefault - maxWorkerCount - minWorkerCount - name - podCpu - podMemory - workerConcurrency type: object FieldValidationError: properties: code: type: string field: type: string message: type: string required: - code - field - message type: object DeploymentEnvironmentVariableRequest: properties: isSecret: description: Whether the environment variable is a secret. example: false type: boolean key: description: The environment variable key, used to call the value in code. example: my-var type: string value: description: The environment variable value. example: my-var-value type: string required: - isSecret - key type: object DeploymentRemoteExecutionRequest: properties: allowedIpAddressRanges: items: type: string type: array enabled: type: boolean taskLogBucket: type: string taskLogUrlPattern: type: string required: - enabled type: object DeploymentScalingSpecRequest: properties: hibernationSpec: $ref: '#/components/schemas/DeploymentHibernationSpecRequest' type: object UpdateWorkerQueueRequest: properties: astroMachine: description: >- The Astro machine for each worker in the queue. Required for Astro Hosted deployments. enum: - A5 - A10 - A20 - A40 - A60 - A120 - A160 type: string id: description: >- The worker queue's ID. If not provided, a new worker queue will be created. example: clmha1mzc000b08mi96n182au type: string isDefault: description: >- Whether the worker queue is the default worker queue on the Deployment. example: true type: boolean maxWorkerCount: description: The maximum number of workers that can run at once. minimum: 1 type: integer minWorkerCount: description: The minimum number of workers running at once. minimum: 0 type: integer name: description: The worker queue's name. example: My worker queue maxLength: 63 type: string nodePoolId: description: >- The node pool ID associated with the worker queue. Required for Hybrid deployments. type: string podEphemeralStorage: description: >- The ephemeral storage limit for each worker Pod. Must be a valid Kubernetes resource string, e.g. `10Gi`. type: string workerConcurrency: description: >- The maximum number of concurrent tasks that a worker Pod can run at a time. minimum: 1 type: integer required: - isDefault - maxWorkerCount - minWorkerCount - name - workerConcurrency type: object UpdateDeploymentInstanceSpecRequest: properties: au: description: >- The number of Astro unit allocated to the Deployment pod. Minimum `5`, Maximum `24`. example: 5 maximum: 24 minimum: 5 type: integer replicas: description: >- The number of replicas the pod should have. Minimum `1`, Maximum `4`. example: 1 maximum: 4 minimum: 1 type: integer required: - au - replicas type: object DeploymentHibernationSpec: properties: override: $ref: '#/components/schemas/DeploymentHibernationOverride' schedules: description: The list of schedules for deployment hibernation items: $ref: '#/components/schemas/DeploymentHibernationSchedule' type: array type: object DeploymentHibernationStatus: properties: isHibernating: description: If the deployment is currently in hibernating state or not type: boolean nextEventAt: description: Timestamp of the next scheduled hibernation event for the deployment type: string nextEventType: description: >- The type of the next scheduled event for the deployment. Either HIBERNATE or WAKE enum: - HIBERNATE - WAKE type: string reason: description: Reason for the current hibernation state of the deployment type: string required: - isHibernating type: object DeploymentHibernationSpecRequest: properties: override: $ref: '#/components/schemas/DeploymentHibernationOverrideRequest' schedules: description: The list of schedules for deployment hibernation items: $ref: '#/components/schemas/DeploymentHibernationSchedule' maxItems: 10 type: array type: object DeploymentHibernationOverride: properties: isActive: description: Whether the override is currently active or not type: boolean isHibernating: description: Whether to go into hibernation or not via the override rule type: boolean overrideUntil: description: Timestamp till the override on the hibernation schedule is in effect format: date-time type: string type: object DeploymentHibernationSchedule: properties: description: description: A brief description of the schedule maxLength: 200 type: string hibernateAtCron: description: >- A 5-part cron expression defining the times at which the deployment should hibernate type: string isEnabled: description: >- Toggle this schedule on or off. If set to false, this schedule will have no effect on hibernation. type: boolean wakeAtCron: description: >- A 5-part cron expression definingh the times at which the deployment should wake from hibernation type: string required: - hibernateAtCron - isEnabled - wakeAtCron type: object DeploymentHibernationOverrideRequest: properties: isHibernating: description: Whether to go into hibernation or not via the override rule type: boolean overrideUntil: description: Timestamp till the override on the hibernation schedule is in effect type: string type: object securitySchemes: JWT: scheme: bearer type: http ````