object-storage-2

List services

Returns a list of object storage services.

get/1.3/object-storage-2

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/object-storage-2
  • Auth: HTTP bearer

Query parameters

limitinteger

Schema for a query parameter specifying the maximum number of entries to return (limit).

Example:10

Number of entries to receive at most.

offsetinteger

Schema for a query parameter specifying the offset for pagination.

Offset for retrieved results.

sort'created_at' | '-created_at' | 'service_name' | '-service_name' | 'operational_state' | '-operational_state' | 'region_name' | '-region_name'

Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order.

Example:-created_at

Order of returned results.

Response

OK

uuidstring
namestring
regionstring
configured_status'started' | 'stopped'
operational_state'pending' | 'setup-service' | 'setup-network' | 'setup-tls' | 'setup-public-endpoint' | 'setup-private-endpoint' | 'setup-dns' | 'cleanup-deleted-buckets' | 'setup-iam' | 'setup-checkup' | 'running' | 'stopped' | 'delete-private-endpoint' | 'delete-public-endpoint' | 'delete-buckets' | 'delete-iam' | 'delete-namespace' | 'delete-dns' | 'delete-tls' | 'delete-network' | 'delete-service'
termination_protectionboolean
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "configured_status": "started",
    "created_at": "2023-05-07T15:55:24.655776Z",
    "custom_domains": [
      {
        "domain_name": "objects.example-company.com",
        "type": "public"
      }
    ],
    "endpoints": [
      {
        "domain_name": "7mf5k.upbucket.com",
        "iam_url": "https://7mf5k.upbucket.com:4443/iam",
        "sts_url": "https://7mf5k.upbucket.com:4443/sts",
        "type": "public"
      },
      {
        "domain_name": "7mf5k-private.upbucket.com",
        "iam_url": "https://7mf5k-private.upbucket.com:4443/iam",
        "sts_url": "https://7mf5k-private.upbucket.com:4443/sts",
        "type": "private"
      },
      {
        "domain_name": "static.7mf5k.upbucket.com",
        "type": "static"
      }
    ],
    "labels": [
      {
        "key": "example-key",
        "value": "example-value"
      }
    ],
    "name": "example-service",
    "networks": [
      {
        "family": "IPv4",
        "name": "example-public-network",
        "type": "public"
      },
      {
        "family": "IPv4",
        "name": "example-private-network",
        "type": "private",
        "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4"
      }
    ],
    "operational_state": "running",
    "region": "europe-1",
    "state_messages": [],
    "static_website": [
      {
        "domain": "objects.example-company.com",
        "custom_domain_id": 1,
        "bucket_name": "website-prod",
        "bucket_prefix": "public/",
        "index_document": "index.html",
        "status": "active",
        "error_pages": [
          {
            "status_code": 404,
            "error_document": "404.html"
          },
          {
            "status_range": {
              "start": 500,
              "end": 599
            },
            "error_document": "500.html"
          },
          {
            "status_range": {
              "start": 500,
              "end": 510
            },
            "error_document": "500.html"
          }
        ],
        "created_at": "2023-05-07T16:10:30.123456Z",
        "updated_at": "2023-05-07T16:10:30.123456Z"
      }
    ],
    "updated_at": "2023-05-07T21:38:15.757405Z",
    "usage": {
      "total_objects": 310499,
      "total_size_bytes": 32414921734
    },
    "uuid": "1200ecde-db95-4d1c-9133-6508f3232567"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.