Skip to main content
Version: latest

Returns the cluster backup result

GET 

https://api.spectrocloud.com/v1/spectroclusters/:uid/features/backup

Returns the cluster backup result

Request

Path Parameters

    uid stringrequired

Query Parameters

    backupRequestUid string

Header Parameters

    ProjectUid string

    A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources

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

    Cluster Backup Spec

    clusterUidstring
    config

    Cluster backup config

    backupLocationNamestring
    backupLocationUidstring
    backupNamestring
    backupPrefixstring
    durationInHoursint64
    includeAllDisksboolean
    includeClusterResourceModestring

    Possible values: [Always, Auto, Never]

    Specifies the scope of cluster-wide resources to include in the backup based on the flag'--include-cluster-resources':

    • "Always": --include-cluster-resources=true, which includes all cluster-wide resources; restores only on the original cluster.
    • "Auto": don't specify --include-cluster-resources, which exclude general cluster-wide resources, but includes PersistentVolumes linked to selected namespaces.
    • "Never": --include-cluster-resources=false, exclude all cluster-wide resources, including PersistentVolumes.
    includeClusterResourcesboolean

    Deprecated. Use includeClusterResourceMode

    locationTypestring
    namespacesstring[]
    schedule

    Cluster feature schedule

    scheduledRunTimestring
    status

    Cluster Backup Status

    clusterBackupStatuses undefined[]
  • Array [
  • actor

    Compliance Scan actor

    actorTypestring
    uidstring
    backupConfig

    Backup config

    includeAllDisksboolean
    includeClusterResourceModestring

    Possible values: [Always, Auto, Never]

    Specifies the scope of cluster-wide resources to include in the backup based on the flag'--include-cluster-resources':

    • "Always": --include-cluster-resources=true, which includes all cluster-wide resources; restores only on the original cluster.
    • "Auto": don't specify --include-cluster-resources, which exclude general cluster-wide resources, but includes PersistentVolumes linked to selected namespaces.
    • "Never": --include-cluster-resources=false, exclude all cluster-wide resources, including PersistentVolumes.
    includeClusterResourcesboolean

    Deprecated. Use includeClusterResourceMode

    namespacesstring[]
    backupLocationConfig

    Backup location configuration

    namestring
    typestring
    uidstring
    backupRequestUidstring
    backupStatusMeta undefined[]
  • Array [
  • 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.

  • ]
  • restoreStatusMeta undefined[]
  • Array [
  • backupNamestring
    destinationClusterRef object
    kindstring
    namestring
    uidstringrequired
    restoreStatestring
  • ]
  • statestring
  • ]

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header
curl -L 'https://api.spectrocloud.com/v1/spectroclusters/:uid/features/backup' \
-H 'Accept: application/json' \
-H 'ApiKey: <ApiKey>'
Request Collapse all
Base URL
https://api.spectrocloud.com
Auth
Parameters
— pathrequired
— query
— header