> ## Documentation Index > Fetch the complete documentation index at: https://docs.nscale.com/llms.txt > Use this file to discover all available pages before exploring further. # List regions > Lists compute service compatible regions. ## OpenAPI ````yaml /openapi/compute-openapi.yaml get /api/v1/organizations/{organizationID}/regions openapi: 3.0.3 info: title: Compute Service API description: >- The Compute Service API provides services that allows provisioning and life cycle management of Compute clusters. version: 1.13.0 servers: - url: https://compute.nks.europe-west4.nscale.com description: Production security: [] paths: /api/v1/organizations/{organizationID}/regions: description: Accesses a filtered list of regions for use with different cluster types. parameters: - $ref: '#/components/parameters/organizationIDParameter' get: tags: - Regions summary: List regions description: Lists compute service compatible regions. responses: '200': $ref: '#/components/responses/regionsResponse' '400': $ref: '#/components/responses/badRequestResponse' '401': $ref: '#/components/responses/unauthorizedResponse' '403': $ref: '#/components/responses/forbiddenResponse' '500': $ref: '#/components/responses/internalServerErrorResponse' security: - oauth2Authentication: [] components: parameters: organizationIDParameter: name: organizationID in: path description: The organization ID. required: true schema: $ref: '#/components/schemas/kubernetesNameParameter' responses: regionsResponse: description: A list of regions. content: application/json: schema: $ref: '#/components/schemas/regions' example: - metadata: id: c7568e2d-f9ab-453d-9a3a-51375f78426b name: uk-west-1 description: A top secret datacenter somewhere in the UK creationTime: '2023-07-31T10:45:45Z' provisioningStatus: provisioned healthStatus: healthy spec: type: openstack features: physicalNetworks: true badRequestResponse: description: |- Request body failed schema validation, or the request does not contain all the required fields. content: application/json: schema: $ref: '#/components/schemas/error' example: error: invalid_request error_description: request body invalid unauthorizedResponse: description: Authentication failed or the access token has expired. content: application/json: schema: $ref: '#/components/schemas/error' example: error: access_denied error_description: authentication failed forbiddenResponse: description: >- Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. content: application/json: schema: $ref: '#/components/schemas/error' example: error: forbidden error_description: user credentials do not have the required privileges internalServerErrorResponse: description: >- An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. content: application/json: schema: $ref: '#/components/schemas/error' example: error: server_error error_description: failed to token claim schemas: kubernetesNameParameter: description: >- A Kubernetes name. Must be a valid DNS containing only lower case characters, numbers or hyphens, start and end with a character or number, and be at most 63 characters in length. type: string minLength: 1 maxLength: 63 regions: description: A list of regions. type: array items: $ref: '#/components/schemas/regionRead' error: description: Generic error message, compatible with oauth2. type: object required: - error - error_description properties: error: description: >- A terse error string expanding on the HTTP error code. Errors are based on the OAuth 2.02 specification, but are expanded with proprietary status codes for APIs other than those specified by OAuth 2.02. type: string enum: - invalid_request - server_error - access_denied - not_found - conflict - method_not_allowed - unsupported_media_type - request_entity_too_large - unprocessable_content - forbidden error_description: description: Verbose message describing the error. type: string regionRead: description: A region. type: object required: - metadata - spec properties: metadata: $ref: '#/components/schemas/resourceReadMetadata' spec: $ref: '#/components/schemas/regionSpec' resourceReadMetadata: description: Metadata required by all resource reads. allOf: - $ref: '#/components/schemas/staticResourceMetadata' - type: object required: - provisioningStatus - healthStatus properties: deletionTime: description: The time the resource was deleted. type: string format: date-time provisioningStatus: $ref: '#/components/schemas/resourceProvisioningStatus' healthStatus: $ref: '#/components/schemas/resourceHealthStatus' regionSpec: description: Information about the region. type: object required: - type - features properties: type: $ref: '#/components/schemas/regionType' features: $ref: '#/components/schemas/regionFeatures' staticResourceMetadata: description: | This metadata is for resources that just exist, and don't require any provisioning and health status, but benefit from a standardized metadata format. type: object allOf: - $ref: '#/components/schemas/resourceMetadata' - type: object required: - id - creationTime properties: id: description: The unique resource ID. type: string creationTime: description: The time the resource was created. type: string format: date-time createdBy: description: The user who created the resource. type: string modifiedTime: description: The time a resource was updated. type: string format: date-time modifiedBy: description: The user who updated the resource. type: string resourceProvisioningStatus: description: The provisioning state of a resource. type: string enum: - unknown - provisioning - provisioned - deprovisioning - error resourceHealthStatus: description: The health state of a resource. type: string enum: - unknown - healthy - degraded - error regionType: description: The region's provider type. type: string enum: - openstack - kubernetes regionFeatures: description: A set of features the region may provide to clients. type: object required: - physicalNetworks properties: physicalNetworks: description: > If set, this indicates that the region supports physical networks and one should be provisioned for clusters to use. The implication here is the region supports base-metal machines, and these must be provisioned on a physical VLAN etc. type: boolean resourceMetadata: description: Metadata required for all API resource reads and writes. required: - name properties: name: $ref: '#/components/schemas/kubernetesLabelValue' description: description: >- The resource description, this optionally augments the name with more context. type: string tags: $ref: '#/components/schemas/tagList' kubernetesLabelValue: description: >- A valid Kubernetes label value, typically used for resource names that can be indexed in the database. type: string pattern: ^[0-9A-Za-z](?:[0-9A-Za-z-_.]{0,61}[0-9A-Za-z])?$ tagList: description: A list of tags. type: array items: $ref: '#/components/schemas/tag' tag: description: >- A tag mapping arbitrary names to values. These have no special meaning for any component are are intended for use by end users to add additional context to a resource, for example to categorize it. type: object required: - name - value properties: name: description: A unique tag name. type: string value: description: The value of the tag. type: string securitySchemes: oauth2Authentication: description: Operation requires OAuth 2.0 bearer token authentication. type: oauth2 flows: authorizationCode: authorizationUrl: https://identity.nks.europe-west4.nscale.com/oauth2/v2/authorization tokenUrl: https://identity.nks.europe-west4.nscale.com/oauth2/v2/token scopes: {} ````