# UpCloud Object Storage 2 API

**Canonical:** https://apis.io/apis/upcloud/upcloud-object-storage-2-api/  
**Provider:** UpCloud — https://apis.io/providers/upcloud/  
**Base URL:** https://api.upcloud.com  
**Documentation:** https://developers.upcloud.com/api/1.3

UpCloud Object Storage 2 API is one of 29 APIs that [UpCloud](https://apis.io/providers/upcloud/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include object-storage-2. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Object Storage is a computer data storage architecture that manages data as objects as opposed to block storage which manages data as blocks within sectors and tracks. Managed Object storage is commonly used to manage large amounts of unstructured data for example storing large datasets like photos, music, or files in online collaboration services. All customers data is encrypted by default using encryption at rest. Managed Object Storage API commands allow creation, management and deletion of Object Storage devices as well as viewing Object Storage network data usage. Managed Object Storage is fully S3-compliant allowing file and bucket management using existing S3 clients. API follows JSON Merge Patch semantics. Note when modifying nested structures payload should contain entire array, which in a sense is PUT within PATCH for them. JSON Merge Patch uses null to explicitly indicate property deletion while absent properties are ignored, i.e. not modified.

## Operations (60 of 94)

| Method | Path | Summary |
|---|---|---|
| GET | `/1.3/object-storage-2` | List services |
| POST | `/1.3/object-storage-2` | Create service |
| GET | `/1.3/object-storage-2/{service-uuid}` | Get service details |
| PUT | `/1.3/object-storage-2/{service-uuid}` | Replace service |
| DELETE | `/1.3/object-storage-2/{service-uuid}` | Delete service |
| PATCH | `/1.3/object-storage-2/{service-uuid}` | Modify service |
| GET | `/1.3/object-storage-2/{service-uuid}/networks` | List networks |
| POST | `/1.3/object-storage-2/{service-uuid}/networks` | Create network |
| GET | `/1.3/object-storage-2/{service-uuid}/networks/{network-name}` | Get network details |
| DELETE | `/1.3/object-storage-2/{service-uuid}/networks/{network-name}` | Delete network |
| GET | `/1.3/object-storage-2/{service-uuid}/custom-domains` | List custom domains |
| POST | `/1.3/object-storage-2/{service-uuid}/custom-domains` | Attach custom domain |
| GET | `/1.3/object-storage-2/{service-uuid}/custom-domains/{custom-domain-name}` | Get custom domain details |
| DELETE | `/1.3/object-storage-2/{service-uuid}/custom-domains/{custom-domain-name}` | Delete custom domain |
| PATCH | `/1.3/object-storage-2/{service-uuid}/custom-domains/{custom-domain-name}` | Modify custom domain |
| GET | `/1.3/object-storage-2/regions` | List regions |
| GET | `/1.3/object-storage-2/regions/{region-name}` | Get region details |
| GET | `/1.3/object-storage-2/{service-uuid}/metrics` | Get service metrics |
| GET | `/1.3/object-storage-2/{service-uuid}/buckets` | List bucket metrics |
| POST | `/1.3/object-storage-2/{service-uuid}/buckets` | Create bucket |
| DELETE | `/1.3/object-storage-2/{service-uuid}/buckets/{bucket-name}` | Delete bucket |
| GET | `/1.3/object-storage-2/{service-uuid}/metrics/series` | List service metrics series |
| GET | `/1.3/object-storage-2/{service-uuid}/labels` | List labels |
| POST | `/1.3/object-storage-2/{service-uuid}/labels` | Create label |
| GET | `/1.3/object-storage-2/{service-uuid}/labels/{label-key}` | Get label details |
| DELETE | `/1.3/object-storage-2/{service-uuid}/labels/{label-key}` | Delete label |
| PATCH | `/1.3/object-storage-2/{service-uuid}/labels/{label-key}` | Modify label |
| GET | `/1.3/object-storage-2/{service-uuid}/static-websites` | List static website configurations |
| POST | `/1.3/object-storage-2/{service-uuid}/static-websites` | Create static website configuration |
| GET | `/1.3/object-storage-2/{service-uuid}/static-websites/{custom-domain-name}` | Get static website configuration |
| DELETE | `/1.3/object-storage-2/{service-uuid}/static-websites/{custom-domain-name}` | Delete static website configuration |
| PATCH | `/1.3/object-storage-2/{service-uuid}/static-websites/{custom-domain-name}` | Modify static website configuration |
| GET | `/1.3/object-storage-2/{service-uuid}/domains` | List service domains |
| GET | `/1.3/object-storage-2/{service-uuid}/users` | List users |
| POST | `/1.3/object-storage-2/{service-uuid}/users` | Create user |
| GET | `/1.3/object-storage-2/{service-uuid}/users/{username}` | Get user details |
| DELETE | `/1.3/object-storage-2/{service-uuid}/users/{username}` | Delete user |
| GET | `/1.3/object-storage-2/{service-uuid}/users/{username}/access-keys` | List access keys |
| POST | `/1.3/object-storage-2/{service-uuid}/users/{username}/access-keys` | Create access key |
| GET | `/1.3/object-storage-2/{service-uuid}/users/{username}/access-keys/{access-key-id}` | Get access key details |
| DELETE | `/1.3/object-storage-2/{service-uuid}/users/{username}/access-keys/{access-key-id}` | Delete access key |
| PATCH | `/1.3/object-storage-2/{service-uuid}/users/{username}/access-keys/{access-key-id}` | Modify access key details |
| GET | `/1.3/object-storage-2/{service-uuid}/users/{username}/policies` | List attached user policies |
| POST | `/1.3/object-storage-2/{service-uuid}/users/{username}/policies` | Attach user policy |
| DELETE | `/1.3/object-storage-2/{service-uuid}/users/{username}/policies/{nested-name}` | Detach user policy |
| GET | `/1.3/object-storage-2/{service-uuid}/users/{username}/inline-policies/{user-policy-name}` | Get user inline policy |
| DELETE | `/1.3/object-storage-2/{service-uuid}/users/{username}/inline-policies/{user-policy-name}` | Delete user inline policy |
| GET | `/1.3/object-storage-2/{service-uuid}/users/{username}/inline-policies` | List user inline policies |
| POST | `/1.3/object-storage-2/{service-uuid}/users/{username}/inline-policies` | Create user inline policy |
| GET | `/1.3/object-storage-2/{service-uuid}/users/{username}/tags` | Get user tags |
| PUT | `/1.3/object-storage-2/{service-uuid}/users/{username}/tags` | Replace user tags |
| DELETE | `/1.3/object-storage-2/{service-uuid}/users/{username}/tags/{user-tag-key}` | Delete user tag |
| PUT | `/1.3/object-storage-2/{service-uuid}/users/{username}/permissions-boundary` | Create user permissions boundary |
| DELETE | `/1.3/object-storage-2/{service-uuid}/users/{username}/permissions-boundary` | Delete user permissions boundary |
| GET | `/1.3/object-storage-2/{service-uuid}/policies/{policy-name}/versions` | List policy versions |
| POST | `/1.3/object-storage-2/{service-uuid}/policies/{policy-name}/versions` | Create policy version |
| GET | `/1.3/object-storage-2/{service-uuid}/policies/{policy-name}/versions/{policy-version}` | Get policy version |
| DELETE | `/1.3/object-storage-2/{service-uuid}/policies/{policy-name}/versions/{policy-version}` | Delete a policy version |
| GET | `/1.3/object-storage-2/{service-uuid}/policies/{policy-name}` | Get policy details |
| DELETE | `/1.3/object-storage-2/{service-uuid}/policies/{policy-name}` | Delete policy |

…and 34 more operations. They are listed in full on the page.

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/upcloud/openapi/upcloud-object-storage-2-api-openapi.yml
- **Documentation** — https://developers.upcloud.com/api/1.3

## Other UpCloud APIs (12)

- [UpCloud Account API](https://apis.io/apis/upcloud/upcloud-account-api/)
- [UpCloud Account Tokens API](https://apis.io/apis/upcloud/upcloud-account-tokens-api/)
- [UpCloud Audit Logs API](https://apis.io/apis/upcloud/upcloud-audit-logs-api/)
- [UpCloud Currency API](https://apis.io/apis/upcloud/upcloud-currency-api/)
- [UpCloud Database API](https://apis.io/apis/upcloud/upcloud-database-api/)
- [UpCloud Device API](https://apis.io/apis/upcloud/upcloud-device-api/)
- [UpCloud Events API](https://apis.io/apis/upcloud/upcloud-events-api/)
- [UpCloud File Storage API](https://apis.io/apis/upcloud/upcloud-file-storage-api/)
- [UpCloud Firewall Ruleset API](https://apis.io/apis/upcloud/upcloud-firewall-ruleset-api/)
- [UpCloud Gateway API](https://apis.io/apis/upcloud/upcloud-gateway-api/)
- [UpCloud Ip Address API](https://apis.io/apis/upcloud/upcloud-ip-address-api/)
- [UpCloud Kubernetes API](https://apis.io/apis/upcloud/upcloud-kubernetes-api/)

## Tags

object-storage-2

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/upcloud/upcloud-object-storage-2-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/upcloud/.