> ## 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. # Get Deployment options > Get the options available for configuring a Deployment. ## OpenAPI ````yaml /astro/api/v-1/openapi.yaml get /organizations/{organizationId}/deployment-options 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}/deployment-options: get: tags: - Options summary: Get Deployment options description: Get the options available for configuring a Deployment. operationId: GetDeploymentOptions parameters: - description: The ID of the Organization to retrieve Deployment options for. in: path name: organizationId required: true schema: type: string - description: The ID of a Deployment to retrieve options for. in: query name: deploymentId schema: type: string - description: The runtime type of the deployment. in: query name: deploymentType schema: enum: - HYBRID - DEDICATED - STANDARD type: string - description: The executor of the deployment. in: query name: executor schema: enum: - CELERY - KUBERNETES - ASTRO type: string - description: The cloud provider of the cluster for the deployment. in: query name: cloudProvider schema: enum: - AWS - AZURE - GCP type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeploymentOptions' 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 '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal Server Error security: - JWT: [] components: schemas: DeploymentOptions: properties: executors: description: The available executors. items: type: string type: array resourceQuotas: $ref: '#/components/schemas/ResourceQuotaOptions' runtimeReleases: description: The available Astro Runtime versions. items: $ref: '#/components/schemas/RuntimeRelease' type: array schedulerMachines: description: The available scheduler sizes. items: $ref: '#/components/schemas/SchedulerMachine' type: array workerMachines: description: The available worker machine types. items: $ref: '#/components/schemas/WorkerMachine' type: array workerQueues: $ref: '#/components/schemas/WorkerQueueOptions' workloadIdentityOptions: description: The available workload identity options. items: $ref: '#/components/schemas/WorkloadIdentityOption' type: array required: - executors - resourceQuotas - runtimeReleases - schedulerMachines - workerMachines - workerQueues 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 ResourceQuotaOptions: properties: defaultPodSize: $ref: '#/components/schemas/ResourceOption' resourceQuota: $ref: '#/components/schemas/ResourceOption' required: - defaultPodSize - resourceQuota type: object RuntimeRelease: properties: airflowDatabaseMigration: description: Whether the release requires an Airflow database migration. example: false type: boolean airflowVersion: description: The Airflow version that the Runtime image is based on. example: 2.7.1 type: string channel: description: The release channel. example: stable type: string releaseDate: description: >- The time when the version is released in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string stellarDatabaseMigration: description: Whether the release requires a Stellar database migration. example: false type: boolean version: description: The Astro Runtime version. example: 9.1.0 type: string required: - airflowDatabaseMigration - airflowVersion - channel - releaseDate - stellarDatabaseMigration - version type: object SchedulerMachine: properties: name: description: The machine's name. enum: - SMALL - MEDIUM - LARGE - EXTRA_LARGE type: string spec: $ref: '#/components/schemas/MachineSpec' required: - name - spec type: object WorkerMachine: properties: concurrency: $ref: '#/components/schemas/Range' name: description: The machine's name. enum: - A5 - A10 - A20 - A40 - A60 - A120 - A160 type: string spec: $ref: '#/components/schemas/MachineSpec' required: - concurrency - name - spec type: object WorkerQueueOptions: properties: maxWorkers: $ref: '#/components/schemas/Range' minWorkers: $ref: '#/components/schemas/Range' workerConcurrency: $ref: '#/components/schemas/Range' required: - maxWorkers - minWorkers - workerConcurrency type: object WorkloadIdentityOption: properties: label: description: The workload identity label. example: workload-label type: string role: description: The workload identity role. example: workload-role type: string required: - label - role type: object FieldValidationError: properties: code: type: string field: type: string message: type: string required: - code - field - message type: object ResourceOption: properties: cpu: $ref: '#/components/schemas/ResourceRange' memory: $ref: '#/components/schemas/ResourceRange' required: - cpu - memory type: object MachineSpec: properties: concurrency: description: >- The maximum number of tasks that a given machine instance can run at once. example: 10 type: number cpu: description: The CPU quantity. Units are in number of CPU cores. example: '1' type: string ephemeralStorage: description: The ephemeral storage quantity. Units in Gibibytes or `Gi`. example: 10Gi type: string memory: description: The memory quantity. Units in Gibibytes or `Gi`. example: 2Gi type: string required: - cpu - memory type: object Range: properties: ceiling: description: The maximum value. example: 10 type: number default: description: The default value. example: 5 type: number floor: description: The minimum value. example: 1 type: number required: - ceiling - default - floor type: object ResourceRange: properties: ceiling: description: The maximum value. example: '10' type: string default: description: The default value. example: '5' type: string floor: description: The minimum value. example: '1' type: string required: - ceiling - default - floor type: object securitySchemes: JWT: scheme: bearer type: http ````