> ## 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 cluster options > Get all possible options for configuring a cluster. ## OpenAPI ````yaml /astro/api/v-1/openapi.yaml get /organizations/{organizationId}/cluster-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}/cluster-options: get: tags: - Options summary: Get cluster options description: Get all possible options for configuring a cluster. operationId: GetClusterOptions parameters: - description: The ID of the Organization to get cluster options for. in: path name: organizationId required: true schema: type: string - description: The cluster's cloud provider. in: query name: provider schema: enum: - AWS - AZURE - GCP type: string - description: The cluster type. in: query name: type required: true schema: enum: - DEDICATED - HYBRID type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ClusterOptions' type: array 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: ClusterOptions: properties: databaseInstances: description: The available database instances. items: $ref: '#/components/schemas/ProviderInstanceType' type: array defaultDatabaseInstance: $ref: '#/components/schemas/ProviderInstanceType' defaultNodeInstance: $ref: '#/components/schemas/ProviderInstanceType' defaultPodSubnetRange: description: The default pod subnet range. example: 172.21.0.0/19 type: string defaultRegion: $ref: '#/components/schemas/ProviderRegion' defaultServicePeeringRange: description: The default service peering range. example: 172.23.0.0/20 type: string defaultServiceSubnetRange: description: The default service subnet range. example: 172.22.0.0/22 type: string defaultVpcSubnetRange: description: The default VPC subnet range. example: 172.20.0.0/19 type: string nodeCountDefault: description: The default number of nodes. example: 20 type: integer nodeCountMax: description: The maximum number of nodes. example: 100 type: integer nodeCountMin: description: The minimum number of nodes. example: 2 type: integer nodeInstances: description: The available node instances. items: $ref: '#/components/schemas/ProviderInstanceType' type: array provider: description: The cloud provider. enum: - AWS - AZURE - GCP example: AZURE type: string regions: description: The available regions. items: $ref: '#/components/schemas/ProviderRegion' type: array required: - databaseInstances - defaultDatabaseInstance - defaultNodeInstance - defaultRegion - defaultVpcSubnetRange - nodeCountDefault - nodeCountMax - nodeCountMin - nodeInstances - provider - regions 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 ProviderInstanceType: properties: cpu: description: The number of CPUs. Units are in number of CPU cores. example: 4 type: integer memory: description: The amount of memory. Units in Gibibytes or `Gi`. example: 16Gi type: string name: description: The name of the instance type. example: e2-standard-4 type: string required: - cpu - memory - name type: object ProviderRegion: properties: bannedInstances: description: The banned instances in the region. example: - t3.medium items: type: string type: array limited: description: Whether the region is limited. example: true type: boolean location: description: The multi-region location code for DR compatibility. example: US type: string name: description: The name of the region. example: us-east-1 type: string required: - name type: object FieldValidationError: properties: code: type: string field: type: string message: type: string required: - code - field - message type: object securitySchemes: JWT: scheme: bearer type: http ````