Returns the workspace backup result

GET 
/v1/workspaces/:uid/backup

Returns the workspace backup result

Request

Path Parameters

uid stringrequired

Query Parameters

backupRequestUid string

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource.

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

spec

Workspace backup spec

config

Workspace backup config

backupConfig

Cluster backup config

backupLocationNamestring

backupLocationUidstring

backupNamestring

backupPrefixstring

durationInHoursint64

includeAllDisksboolean

includeClusterResourcesboolean

locationTypestring

namespacesstring[]

schedule

Cluster feature schedule

scheduledRunTimestring

clusterUidsstring[]

includeAllClustersboolean

workspaceUidstring

status

Workspace backup status

workspaceBackupStatuses

undefined[]

Array [

actor

Compliance Scan actor

actorTypestring

uidstring

requestUidstring

workspaceBackupConfig

Workspace cluster backup config

backupNamestring

backupState

Workspace backup state

deleteStatestring

statestring

backupTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

clusterBackupRefs

undefined[]

Array [

backupStatusMeta

Backup status meta

backupNamestring

backupState

Backup state

backupTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deleteStatestring

msgstring

statestring

backupedNamespacesstring[]

expiryDatedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

backupUidstring

clusterNamestring

clusterUidstring

]

config

Workspace backup status config

backupNamestring

durationInHoursint64

includeAllDisksboolean

includeClusterResourcesboolean

namespacesstring[]

requestTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

]

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-04-16T17:49:03.000Z",
    "deletionTimestamp": "2024-04-16T17:49:03.000Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-04-16T17:49:03.000Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "config": {
      "backupConfig": {
        "backupLocationName": "string",
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": 0,
        "includeAllDisks": true,
        "includeClusterResources": true,
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "clusterUids": [
        "string"
      ],
      "includeAllClusters": true
    },
    "workspaceUid": "string"
  },
  "status": {
    "workspaceBackupStatuses": [
      {
        "actor": {
          "actorType": "string",
          "uid": "string"
        },
        "requestUid": "string",
        "workspaceBackupConfig": {
          "backupName": "string",
          "backupState": {
            "deleteState": "string",
            "state": "string"
          },
          "backupTime": "2024-04-16T17:49:03.000Z",
          "clusterBackupRefs": [
            {
              "backupStatusMeta": {
                "backupName": "string",
                "backupState": {
                  "backupTime": "2024-04-16T17:49:03.000Z",
                  "deleteState": "string",
                  "msg": "string",
                  "state": "string"
                },
                "backupedNamespaces": [
                  "string"
                ],
                "expiryDate": "2024-04-16T17:49:03.000Z"
              },
              "backupUid": "string",
              "clusterName": "string",
              "clusterUid": "string"
            }
          ],
          "config": {
            "backupName": "string",
            "durationInHours": 0,
            "includeAllDisks": true,
            "includeClusterResources": true,
            "namespaces": [
              "string"
            ]
          },
          "requestTime": "2024-04-16T17:49:03.000Z"
        }
      }
    ]
  }
}

Loading...