VolumeBackup

Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.

Cloud-NativeContainersGoogle CloudKubernetesManaged ServiceContainer Orchestration

Properties

Name Type Description
diskSizeBytes string Output only. The minimum size of the disk to which this VolumeBackup can be restored.
createTime string Output only. The timestamp when this VolumeBackup resource was created.
etag string Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make
updateTime string Output only. The timestamp when this VolumeBackup resource was last updated.
completeTime string Output only. The timestamp when the associated underlying volume backup operation completed.
storageBytes string Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same b
format string Output only. The format used for the volume backup.
stateMessage string Output only. A human readable message explaining why the VolumeBackup is in its current state. This field is only meant for human consumption and should not be used programmatically as this field is n
state string Output only. The current state of this VolumeBackup.
satisfiesPzi boolean Output only. [Output Only] Reserved for future use.
name string Output only. The full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.
volumeBackupHandle string Output only. A storage system-specific opaque handle to the underlying volume backup.
uid string Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
sourcePvc object Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.
satisfiesPzs boolean Output only. [Output Only] Reserved for future use.
View JSON Schema on GitHub

JSON Schema

google-kubernetes-engine-volume-backup-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-kubernetes-engine/json-schema/google-kubernetes-engine-volume-backup-schema.json",
  "title": "VolumeBackup",
  "description": "Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-kubernetes-engine-gkebackup-projects-api-openapi.yml#/components/schemas/VolumeBackup",
  "properties": {
    "diskSizeBytes": {
      "format": "int64",
      "type": "string",
      "description": "Output only. The minimum size of the disk to which this VolumeBackup can be restored.",
      "readOnly": true
    },
    "createTime": {
      "description": "Output only. The timestamp when this VolumeBackup resource was created.",
      "type": "string",
      "readOnly": true,
      "format": "google-datetime"
    },
    "etag": {
      "description": "Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions.",
      "readOnly": true,
      "type": "string"
    },
    "updateTime": {
      "type": "string",
      "format": "google-datetime",
      "description": "Output only. The timestamp when this VolumeBackup resource was last updated.",
      "readOnly": true
    },
    "completeTime": {
      "readOnly": true,
      "format": "google-datetime",
      "description": "Output only. The timestamp when the associated underlying volume backup operation completed.",
      "type": "string"
    },
    "storageBytes": {
      "type": "string",
      "format": "int64",
      "description": "Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted.",
      "readOnly": true
    },
    "format": {
      "description": "Output only. The format used for the volume backup.",
      "readOnly": true,
      "type": "string",
      "enum": [
        "VOLUME_BACKUP_FORMAT_UNSPECIFIED",
        "GCE_PERSISTENT_DISK"
      ]
    },
    "stateMessage": {
      "type": "string",
      "readOnly": true,
      "description": "Output only. A human readable message explaining why the VolumeBackup is in its current state. This field is only meant for human consumption and should not be used programmatically as this field is not guaranteed to be consistent."
    },
    "state": {
      "readOnly": true,
      "enum": [
        "STATE_UNSPECIFIED",
        "CREATING",
        "SNAPSHOTTING",
        "UPLOADING",
        "SUCCEEDED",
        "FAILED",
        "DELETING",
        "CLEANED_UP"
      ],
      "type": "string",
      "description": "Output only. The current state of this VolumeBackup."
    },
    "satisfiesPzi": {
      "description": "Output only. [Output Only] Reserved for future use.",
      "readOnly": true,
      "type": "boolean"
    },
    "name": {
      "readOnly": true,
      "description": "Output only. The full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`.",
      "type": "string"
    },
    "volumeBackupHandle": {
      "readOnly": true,
      "type": "string",
      "description": "Output only. A storage system-specific opaque handle to the underlying volume backup."
    },
    "uid": {
      "readOnly": true,
      "description": "Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.",
      "type": "string"
    },
    "sourcePvc": {
      "$ref": "#/$defs/NamespacedName",
      "description": "Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created."
    },
    "satisfiesPzs": {
      "readOnly": true,
      "type": "boolean",
      "description": "Output only. [Output Only] Reserved for future use."
    }
  },
  "type": "object",
  "$defs": {
    "NamespacedName": {
      "description": "A reference to a namespaced resource in Kubernetes.",
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string",
          "description": "Optional. The Namespace of the Kubernetes resource."
        },
        "name": {
          "description": "Optional. The name of the Kubernetes resource.",
          "type": "string"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/google-kubernetes-engine-volume-backup"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.