> ## 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 endpoint classes > List the available object storage endpoint classes, including supported exposure types and regional availability. ## OpenAPI ````yaml /openapi/storage-openapi.yaml get /api/v1/objectstorageendpointclasses openapi: 3.0.3 info: title: Storage Service API description: |- The Storage Service API provides that allows provisioning and life cycle management of File and Object storage. version: 1.13.0 servers: [] security: [] paths: /api/v1/objectstorageendpointclasses: description: |- Lists all available object storage endpoint classes, detailing supported endpoint exposure types and regional availability. Enables users to discover object storage endpoint options suitable for their workloads. get: tags: - Object storage summary: List endpoint classes description: >- List the available object storage endpoint classes, including supported exposure types and regional availability. parameters: - $ref: '#/components/parameters/regionIDQueryParameter' responses: '200': $ref: '#/components/responses/objectStorageEndpointClassListResponse' '400': $ref: '#/components/responses/badRequestResponse' '401': $ref: '#/components/responses/unauthorizedResponse' '403': $ref: '#/components/responses/forbiddenResponse' '500': $ref: '#/components/responses/internalServerErrorResponse' security: - oauth2Authentication: [] components: parameters: regionIDQueryParameter: name: regionID in: query description: Allows resources to be filtered by region. schema: type: array items: type: string minLength: 1 responses: objectStorageEndpointClassListResponse: description: A list of object storage endpoint classes. content: application/json: schema: $ref: '#/components/schemas/objectStorageEndpointClassListRead' example: - metadata: id: a64f9269-36e0-4312-b8d1-52d93d569b7b name: object-storage-endpoint-class-name creationTime: '2024-05-31T14:11:00Z' description: A small description of the object storage endpoint class. provisioningStatus: provisioned healthStatus: healthy spec: regionId: ba39bff5-b0d8-4c60-89e5-ed1104356b4a supportedEndpointType: - public 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 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: objectStorageEndpointClassListRead: description: A list of object storage endpoint classes. type: array items: $ref: '#/components/schemas/objectStorageEndpointClassRead' 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 objectStorageEndpointClassRead: description: An object storage endpoint class. type: object required: - metadata - spec properties: metadata: $ref: '#/components/schemas/resourceReadMetadata' spec: $ref: '#/components/schemas/objectStorageEndpointClassSpec' 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' objectStorageEndpointClassSpec: description: An object storage endpoint class specification. type: object required: - regionId - supportedEndpointType properties: regionId: description: The region an object storage endpoint class is provisioned in. type: string supportedEndpointType: description: >- The endpoint exposure types supported by the object storage endpoint class. type: array items: $ref: >- #/components/schemas/objectStorageEndpointClassSupportedEndpointType 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 objectStorageEndpointClassSupportedEndpointType: description: >- An endpoint exposure type supported by the object storage endpoint class. type: string enum: - public - private 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: {} ````