Stay organized with collections
Save and categorize content based on your preferences.
The Object Storage API uses Kubernetes custom resources and relies on the Kubernetes Resource Model. The APIs are used for the provisioning and administration of object storage resources. They are used to manage the lifecycle of object storage resources in a given organization, including creating, reading, updating, and deleting buckets. The APIs are also used for listing buckets, setting bucket retention policies, and setting the storage class of buckets. Block storage is managed with standard Kubernetes APIs.
Service endpoint and discovery document
The Storage KRM APIs are provided in three packages depending on zonal deployment or
global deployment.
The API endpoints for the zonal and global Storage APIs are the following,
respectively:
The MANAGEMENT_API_SERVER_ENDPOINT variable is the
endpoint of the Management API server.
Using the kubectl proxy command, you can access that URL in your browser or with a tool such as curl to get the discovery document for the Object Storage API. The kubectl proxy command opens a proxy to the Kubernetes API server on your local machine. After that command is running, you can access the document at
the following URLs:
The Google Distributed Cloud (GDC) air-gapped Object Storage XML API is a RESTful interface that lets you manage object storage data in a programmatic way. As a RESTful API, it relies on method and scoping information to define the operations to perform:
Method information. You specify the method information with standard HTTP methods, such as DELETE, GET, HEAD, and PUT.
Scoping information. You specify the scoping information with an accessible endpoint (URI) and various scoping parameters. For the XML API, the primary scoping parameters are the bucket and object names. Further scope your operations by using HTTP headers and query string parameters.
Volume Storage API overview
To create persistent volumes, follow the steps outlined by the Kubernetes documentation at https://kubernetes.io/docs/concepts/storage/persistent-volumes/. Interaction with Volume Storage within GDC occurs entirely through Kubernetes storage primitives. The Volume Storage driver implements the Container Storage Interface (CSI) protocol and provisions and orchestrates the volumes in the storage system, opaque to the end user of the persistent volume.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eObject Storage APIs utilize Kubernetes custom resources for provisioning and managing object storage, including bucket creation, reading, updating, deletion, retention policies, and storage class settings.\u003c/p\u003e\n"],["\u003cp\u003eThe Storage KRM APIs are available in three packages based on zonal or global deployment, with specific API endpoints provided for each scenario.\u003c/p\u003e\n"],["\u003cp\u003eThe Google Distributed Cloud air-gapped Object Storage XML API, a RESTful interface, uses HTTP methods and scoping parameters like bucket and object names for managing data programmatically.\u003c/p\u003e\n"],["\u003cp\u003eVolume storage in GDC is managed using standard Kubernetes APIs and persistent volume creation, and employs the Container Storage Interface (CSI) protocol, with a single supported storage class: standard-rwo.\u003c/p\u003e\n"]]],[],null,["# Storage API overview\n\nThe Object Storage API uses Kubernetes custom resources and relies on the Kubernetes Resource Model. The APIs are used for the provisioning and administration of object storage resources. They are used to manage the lifecycle of object storage resources in a given organization, including creating, reading, updating, and deleting buckets. The APIs are also used for listing buckets, setting bucket retention policies, and setting the storage class of buckets. Block storage is managed with standard Kubernetes APIs.\n\nService endpoint and discovery document\n---------------------------------------\n\nThe Storage KRM APIs are provided in three packages depending on zonal deployment or\nglobal deployment.\n\nThe API endpoints for the zonal and global Storage APIs are the following,\nrespectively:\n\n- `https://`\u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e`/apis/object.gdc.goog/v1`\n- `https://`\u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e`/apis/object.global.gdc.goog/v1`\n- `https://`\u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e`/apis/storage.global.gdc.goog/v1`\n\nThe \u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e variable is the\nendpoint of the Management API server.\n\nUsing the `kubectl proxy` command, you can access that URL in your browser or with a tool such as `curl` to get the discovery document for the Object Storage API. The `kubectl proxy` command opens a proxy to the Kubernetes API server on your local machine. After that command is running, you can access the document at\nthe following URLs:\n\n- `http://127.0.0.1:8001/apis/object.gdc.goog/v1`\n- `http://127.0.0.1:8001/apis/object.global.gdc.goog/v1`\n- `http://127.0.0.1:8001/apis/storage.global.gdc.goog/v1`\n\nS3 REST API overview\n--------------------\n\nThe Google Distributed Cloud (GDC) air-gapped Object Storage XML API is a RESTful interface that lets you manage object storage data in a programmatic way. As a RESTful API, it relies on method and scoping information to define the operations to perform:\n\n- **Method information** . You specify the method information with standard HTTP methods, such as `DELETE`, `GET`, `HEAD`, and `PUT`.\n- **Scoping information**. You specify the scoping information with an accessible endpoint (URI) and various scoping parameters. For the XML API, the primary scoping parameters are the bucket and object names. Further scope your operations by using HTTP headers and query string parameters.\n\nVolume Storage API overview\n---------------------------\n\nTo create persistent volumes, follow the steps outlined by the Kubernetes documentation at \u003chttps://kubernetes.io/docs/concepts/storage/persistent-volumes/\u003e. Interaction with Volume Storage within GDC occurs entirely through Kubernetes storage primitives. The Volume Storage driver implements the Container Storage Interface (CSI) protocol and provisions and orchestrates the volumes in the storage system, opaque to the end user of the persistent volume.\n\nGDC supports a single storage class of type *standard-rwo* . See \u003chttps://kubernetes.io/docs/concepts/storage/storage-classes/\u003e for more information on storage classes."]]
