Returns the workspace restore result

GET 
/v1/workspaces/:uid/restore

Returns the workspace restore result

Request

Path Parameters

uid stringrequired

Query Parameters

restoreRequestUid 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 restore spec

workspaceUidstring

status

Workspace restore status

workspaceRestoreStatuses

undefined[]

Array [

actor

Compliance Scan actor

actorTypestring

uidstring

requestUidstring

workspaceRestoreConfig

Workspace cluster restore config

backupNamestring

clusterRestoreRefs

undefined[]

Array [

backupNamestring

clusterNamestring

clusterUidstring

restoreStatusMeta

Workspace cluster restore state

msgstring

restoreTimedate-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.

statestring

restoreUidstring

]

restoreState

Workspace restore state

deleteStatestring

statestring

restoreTimedate-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-05-01T20:07:46.731Z",
    "deletionTimestamp": "2024-05-01T20:07:46.731Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-05-01T20:07:46.731Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "workspaceUid": "string"
  },
  "status": {
    "workspaceRestoreStatuses": [
      {
        "actor": {
          "actorType": "string",
          "uid": "string"
        },
        "requestUid": "string",
        "workspaceRestoreConfig": {
          "backupName": "string",
          "clusterRestoreRefs": [
            {
              "backupName": "string",
              "clusterName": "string",
              "clusterUid": "string",
              "restoreStatusMeta": {
                "msg": "string",
                "restoreTime": "2024-05-01T20:07:46.731Z",
                "state": "string"
              },
              "restoreUid": "string"
            }
          ],
          "restoreState": {
            "deleteState": "string",
            "state": "string"
          },
          "restoreTime": "2024-05-01T20:07:46.731Z"
        }
      }
    ]
  }
}

Loading...