Skip to main content

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​

OK

Schema

    metadata

    object

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

    annotations

    object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    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

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

    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.

  • ]

Loading...