> ## 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. # Create volume > Create a volume on the Region and project implied by its Network. The VolumeClass and requested capacity are immutable after creation. ## OpenAPI ````yaml /openapi/region-openapi.yaml post /api/v2/volumes openapi: 3.0.3 info: title: Region Service API description: >- Cloud region discovery and routing service. This is service not intended for direct access by end users. Region related functionality is typically exposed by higher level services e.g. Compute and Kubernetes, that provide subsets of resources that are compatible with that service. version: 1.13.0 servers: - url: https://region.nks.europe-west4.nscale.com description: Production security: [] paths: /api/v2/volumes: description: Manages project-scoped block storage volumes anchored to a Network. post: tags: - Volumes summary: Create volume description: |- Create a volume on the Region and project implied by its Network. The VolumeClass and requested capacity are immutable after creation. requestBody: $ref: '#/components/requestBodies/volumeV2CreateRequest' responses: '202': $ref: '#/components/responses/volumeV2Response' '400': $ref: '#/components/responses/badRequestResponse' '401': $ref: '#/components/responses/unauthorizedResponse' '403': $ref: '#/components/responses/forbiddenResponse' '404': $ref: '#/components/responses/notFoundResponse' '422': $ref: '#/components/responses/unprocessableContentResponse' '500': $ref: '#/components/responses/internalServerErrorResponse' security: - oauth2Authentication: [] components: requestBodies: volumeV2CreateRequest: description: A request to create a volume. content: application/json: schema: $ref: '#/components/schemas/volumeV2Create' example: metadata: name: database-data description: Persistent database storage tags: - name: environment value: production spec: networkId: 61f0ad85-3001-41cb-824a-e6a047668dfe volumeClassId: 44444444-4444-4444-4444-444444444444 sizeGiB: 200 responses: volumeV2Response: description: A volume. content: application/json: schema: $ref: '#/components/schemas/volumeV2Read' example: metadata: id: a64f9269-36e0-4312-b8d1-52d93d569b7b name: database-data organizationId: 9a8c6370-4065-4d4a-9da0-7678df40cd9d projectId: e36c058a-8eba-4f5b-91f4-f6ffb983795c creationTime: '2026-08-10T12:00:00Z' createdBy: john.doe@acme.com provisioningStatus: provisioned healthStatus: healthy tags: - name: environment value: production spec: networkId: 61f0ad85-3001-41cb-824a-e6a047668dfe volumeClassId: 44444444-4444-4444-4444-444444444444 sizeGiB: 200 status: regionId: ba39bff5-b0d8-4c60-89e5-ed1104356b4a sizeGiB: 200 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 trace_id: 57bc14d9bd461f0b5a72db830149b67a 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 trace_id: 57bc14d9bd461f0b5a72db830149b67a 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 trace_id: 57bc14d9bd461f0b5a72db830149b67a notFoundResponse: description: Unable to find a resource. content: application/json: schema: $ref: '#/components/schemas/error' example: error: not_found error_description: the requested resource does not exist trace_id: 57bc14d9bd461f0b5a72db830149b67a unprocessableContentResponse: description: >- The provided request was syntactically correct but the instruction was unable to be processed due to semantic errors. content: application/json: schema: $ref: '#/components/schemas/error' example: error: unprocessable_content error_description: the request body was in the wrong format trace_id: 57bc14d9bd461f0b5a72db830149b67a 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 trace_id: 57bc14d9bd461f0b5a72db830149b67a schemas: volumeV2Create: description: A volume creation request. type: object required: - metadata - spec properties: metadata: $ref: '#/components/schemas/resourceMetadata' spec: $ref: '#/components/schemas/volumeV2Spec' volumeV2Read: description: A block storage volume. type: object required: - metadata - spec - status properties: metadata: $ref: '#/components/schemas/projectScopedResourceReadMetadata' spec: $ref: '#/components/schemas/volumeV2Spec' status: $ref: '#/components/schemas/volumeV2Status' 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 trace_id: description: Unique trace identifier for the request. type: string 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' volumeV2Spec: description: A volume's immutable desired Network anchor and capacity. type: object required: - networkId - volumeClassId - sizeGiB properties: networkId: description: >- The Network that determines the volume's Region and project association. allOf: - $ref: '#/components/schemas/networkId' volumeClassId: description: The provider-neutral VolumeClass used to provision the volume. type: string sizeGiB: description: The requested volume capacity in whole GiB. type: integer format: int64 minimum: 1 projectScopedResourceReadMetadata: description: Metadata required by project scoped resource reads. allOf: - $ref: '#/components/schemas/organizationScopedResourceReadMetadata' - type: object required: - projectId properties: projectId: description: The project identifier the resource belongs to. type: string volumeV2Status: description: Provider-observed volume state. type: object required: - regionId properties: regionId: description: The Region in which the volume is provisioned. allOf: - $ref: '#/components/schemas/regionId' sizeGiB: description: The provider-observed volume capacity in whole GiB. type: integer format: int64 minimum: 1 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' networkId: description: A network ID. type: string format: uuid x-go-type: regionids.NetworkID x-go-type-import: name: regionids path: github.com/unikorn-cloud/region/pkg/ids organizationScopedResourceReadMetadata: description: Metadata required by organization scoped resource reads. allOf: - $ref: '#/components/schemas/resourceReadMetadata' - type: object required: - organizationId properties: organizationId: description: The organization identifier the resource belongs to. type: string regionId: description: A region ID. type: string format: uuid x-go-type: regionids.RegionID x-go-type-import: name: regionids path: github.com/unikorn-cloud/region/pkg/ids 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 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' 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 - pending - provisioning - provisioned - deprovisioning - error resourceHealthStatus: description: The health state of a resource. type: string enum: - unknown - healthy - degraded - error 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: {} ````