object-storage-2

Modify service

Modifies existing object storage service by given {service_uuid}.

patch/1.3/object-storage-2/{service-uuid}

Request

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

Path parameters

service-uuidstring uuid required

The unique identifier for the service.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

Request body

namestring
configured_status'started' | 'stopped'

Schema for the configured status of a property.

termination_protectionboolean

Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.

Example request

{
  "name": "example-service",
  "configured_status": "started",
  "networks": [
    {
      "name": "example-private-network",
      "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4",
      "type": "private",
      "family": "IPv4"
    }
  ],
  "labels": null
}

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": [],
  "endpoints": [
    {
      "type": "public",
      "mode": "api",
      "domain_name": "7mf5k.upbucket.com",
      "iam_url": "https://7mf5k.upbucket.com:4443/iam",
      "sts_url": "https://7mf5k.upbucket.com:4443/sts"
    },
    {
      "type": "private",
      "mode": "api",
      "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": "public",
      "mode": "static-website",
      "domain_name": "7mf5k-static.upbucket.com"
    }
  ],
  "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": "setup-checkup",
  "region": "europe-1",
  "state_messages": [
    {
      "code": "waiting_certificate_issuing",
      "created_at": "2025-01-16T11:20:40.372611Z",
      "message": "Certificate issuing is in progress for domains: 7mf5k-private.upbucket.com, *.7mf5k-private.upbucket.com.",
      "operational_state": "setup-checkup",
      "updated_at": "2025-01-16T11:20:40.372611Z"
    }
  ],
  "static_websites": [
    {
      "domain_name": "7mf5k-static.upbucket.com",
      "bucket_name": "my-website",
      "bucket_prefix": "",
      "index_document": "index.html",
      "enabled": true,
      "error_pages": [
        {
          "status_code": 404,
          "error_document": "404.html"
        }
      ],
      "created_at": "2023-05-07T15:55:24.655776Z",
      "updated_at": "2023-05-07T15:55:24.655776Z"
    }
  ],
  "updated_at": "2023-05-07T21:38:15.757405Z",
  "usage": {
    "total_objects": 310499,
    "total_size_bytes": 32414921734
  },
  "users": [
    {
      "access_keys": [
        {
          "access_key_id": "AKIA63F41D01345BB477",
          "created_at": "2023-05-07T20:52:19.705405Z",
          "last_used_at": "2023-05-07T20:52:17Z",
          "status": "Active"
        }
      ],
      "arn": "urn:ecs:iam::123bbb5c6a4240409e07f7d89fe28891:user/example_user",
      "created_at": "2023-05-07T15:55:24.655776Z",
      "policies": [
        {
          "arn": "urn:ecs:iam:::policy/ECSS3FullAccess",
          "name": "ECSS3FullAccess"
        },
        {
          "arn": "urn:ecs:iam:::policy/IAMFullAccess",
          "name": "IAMFullAccess"
        }
      ],
      "username": "example_user"
    }
  ],
  "uuid": "1200ecde-db95-4d1c-9133-6508f3232567"
}

Changes

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