Skip to main content

List Backups

GET 

/configuration-hub/backups

This API gets a list of existing backups for the current tenant.

Request

Query Parameters

    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    status: eq

    Example: status eq "COMPLETE"

Responses

List of existing backups.

Schema

  • Array [

  • jobId string

    Unique id assigned to this backup.

    status string

    Possible values: [NOT_STARTED, IN_PROGRESS, COMPLETE, CANCELLED, FAILED]

    Status of the backup.

    type string

    Possible values: [BACKUP]

    Type of the job, will always be BACKUP for this type of job.

    tenant string

    The name of the tenant performing the upload

    requesterName string

    The name of the requester.

    fileExists boolean

    Default value: true

    Whether or not a file was created and stored for this backup.

    created date-time

    The time the job was started.

    modified date-time

    The time of the last update to the job.

    completed date-time

    The time the job was completed.

    name string

    The name assigned to the upload file in the request body.

    userCanDelete boolean

    Default value: true

    Whether this backup can be deleted by a regular user.

    isPartial boolean

    Whether this backup contains all supported object types or only some of them.

    backupType string

    Possible values: [UPLOADED, AUTOMATED, MANUAL]

    Denotes how this backup was created.

    • MANUAL - The backup was created by a user.
    • AUTOMATED - The backup was created by devops.
    • AUTOMATED_DRAFT - The backup was created during a draft process.
    • UPLOADED - The backup was created by uploading an existing configuration file.

    options

    object

    nullable

    Backup options control what will be included in the backup.

    includeTypes string[]

    Possible values: [ACCESS_PROFILE, ACCESS_REQUEST_CONFIG, ATTR_SYNC_SOURCE_CONFIG, AUTH_ORG, CAMPAIGN_FILTER, FORM_DEFINITION, GOVERNANCE_GROUP, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, LIFECYCLE_STATE, NOTIFICATION_TEMPLATE, PASSWORD_POLICY, PASSWORD_SYNC_GROUP, PUBLIC_IDENTITIES_CONFIG, ROLE, RULE, SEGMENT, SERVICE_DESK_INTEGRATION, SOD_POLICY, SOURCE, TAG, TRANSFORM, TRIGGER_SUBSCRIPTION, WORKFLOW]

    Object type names to be included in a Configuration Hub backup command.

    objectOptions

    object

    Additional options targeting specific objects related to each item in the includeTypes field.

    property name*

    ObjectExportImportNames

    includedNames string[]

    Object names to be included in a backup.

    hydrationStatus string

    Possible values: [HYDRATED, NOT_HYDRATED]

    Whether the object details of this backup are ready.

    totalObjectCount int64

    Number of objects contained in this backup.

    cloudStorageStatus string

    Possible values: [SYNCED, NOT_SYNCED, SYNC_FAILED]

    Whether this backup has been transferred to a customer storage location.

  • ]

Loading...