Skip to main content
GET
/
api
/
v1
/
objectstorageendpoints
List endpoints
curl --request GET \
  --url https://api.example.com/api/v1/objectstorageendpoints \
  --header 'Authorization: Bearer <token>'
[
  {
    "metadata": {
      "id": "a64f9269-36e0-4312-b8d1-52d93d569b7b",
      "name": "my-s3-endpoint",
      "organizationId": "9a8c6370-4065-4d4a-9da0-7678df40cd9d",
      "projectId": "e36c058a-8eba-4f5b-91f4-f6ffb983795c",
      "creationTime": "2024-05-31T14:11:00Z",
      "createdBy": "john.doe@acme.com",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy",
      "tags": [
        {
          "name": "tag-name",
          "value": "tag-value"
        }
      ]
    },
    "spec": {
      "objectStorageEndpointClassId": "7b6f8b33-3ca8-4db2-b7ab-7bbf683efc6d",
      "identityPolicies": [
        {
          "name": "bucket-admin",
          "document": {
            "Version": "2012-10-17",
            "Statement": [
              {
                "Effect": "Allow",
                "Action": [
                  "s3:ListBucket",
                  "s3:GetObject"
                ],
                "Resource": [
                  "arn:aws:s3:::example-bucket",
                  "arn:aws:s3:::example-bucket/*"
                ]
              }
            ]
          }
        }
      ]
    },
    "status": {
      "regionId": "ba39bff5-b0d8-4c60-89e5-ed1104356b4a",
      "exposure": {
        "public": {
          "dnsName": "s3.example.com"
        }
      }
    }
  }
]

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.

Authorizations

​
Authorization
string
header
required

Operation requires OAuth 2.0 bearer token authentication.

Query Parameters

​
tag
string[]

A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog".

​
organizationID
string[]

Allows resources to be filtered by organization.

​
projectID
string[]

Allows resources to be filtered by project.

​
regionID
string[]

Allows resources to be filtered by region.

Minimum string length: 1

Response

A list of object storage endpoints.

​
metadata
object
required

Metadata required by project scoped resource reads.

​
spec
object
required

An object storage endpoint specification.

​
status
object
required

The observed status of an object storage endpoint.