---
title: "Get endpoint"
method: GET
path: "/api/v1/objectstorageendpoints/{objectStorageEndpointID}"
tags: ["Object storage"]
---

# Get endpoint

`GET /api/v1/objectstorageendpoints/{objectStorageEndpointID}`

Returns a single object storage endpoint, including its class selection, configured identity policies, and any exposure details that have been provisioned.

## Response `200`

An object storage endpoint.

- ObjectStorageEndpointRead — An S3-compatible object storage endpoint that allows users to self-service create buckets through the access it exposes.
  - `metadata` ProjectScopedResourceReadMetadata, required — Metadata required for all API resource reads and writes.
    - `name` string, required — A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
    - `description` string — The resource description, this optionally augments the name with more context.
    - `tags` Tag[] — A list of tags.
      - `name` string, required — A unique tag name.
      - `value` string, required — The value of the tag.
    - `id` string, required — The unique resource ID.
    - `creationTime` string, date-time, required — The time the resource was created.
    - `createdBy` string — The user who created the resource.
    - `modifiedTime` string, date-time — The time a resource was updated.
    - `modifiedBy` string — The user who updated the resource.
    - `deletionTime` string, date-time — The time the resource was deleted.
    - `provisioningStatus` 'unknown' | 'provisioning' | 'provisioned' | 'deprovisioning' | 'error', required — The provisioning state of a resource.
    - `healthStatus` 'unknown' | 'healthy' | 'degraded' | 'error', required — The health state of a resource.
    - `organizationId` string, required — The organization identifier the resource belongs to.
    - `projectId` string, required — The project identifier the resource belongs to.
  - `spec` ObjectStorageEndpointSpec, required — An object storage endpoint specification.
    - `objectStorageEndpointClassId` string, required — The immutable object storage endpoint class selected when the endpoint was created.
    - `identityPolicies` ObjectStorageIdentityPolicySpec[] — A list of identity policies configured for an object storage endpoint.
      - `name` string, required — The identity policy name. Names must be unique within the object storage endpoint.
      - `document` ObjectStorageIdentityPolicyDocument, required — A provider-specific identity policy document represented as an arbitrary JSON object.
  - `status` ObjectStorageEndpointStatus, required — The observed status of an object storage endpoint.
    - `regionId` string, required — The region the object storage endpoint is provisioned in.
    - `exposure` ObjectStorageEndpointExposureStatus — The externally reachable endpoints for an object storage endpoint.
      - `public` ObjectStorageEndpointExposureDetailsStatus — Connection details for a specific exposure mode.
        - `dnsName` string, required — The DNS hostname clients use to reach the endpoint.

## Other responses

- `400` — Request body failed schema validation, or the request does not contain all the required fields.
- `401` — Authentication failed or the access token has expired.
- `403` — 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.
- `404` — Unable to find a resource.
- `500` — 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.

---

[API](https://skmtc.net/nscale/apis/region-service-api.md) · [All operations](https://skmtc.net/nscale/apis/region-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nscale/region-service-api/revisions/c2991b23da6e/schema)