Skip to main content

Returns the workspace backup result

GET 
https://api.spectrocloud.com/v1/workspaces/:uid/backup

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

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

    Populated by the system. Read-only.

    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.

  • ]
curl -L -X GET 'https://api.spectrocloud.com/v1/workspaces/:uid/backup' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'
Request Collapse all
Base URL
https://api.spectrocloud.com
Auth
Parameters
— pathrequired
— query
— header