Gets list of Uploaded backups

GET 
/configuration-hub/backups/uploads

Returns a list of the current uploaded backups associated with the current tenant. A filter "status" can be added to only return the Completed, Failed, or Successful uploads

Request

Query Parameters

status string
Filter listed uploaded backups by status of operation
Example: COMPLETE

Responses

200

List of existing uploaded backups.

application/json

Schema

Schema

• Array [
jobId stringrequired

Unique id assigned to this job.

status stringrequired

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

Status of the job.

type stringrequired

Possible values: [BACKUP, DRAFT]

Type of the job, either Backup or Draft.

tenant string

The name of the tenant performing the upload

requesterName string

The name of the requester.

created date-timerequired

The time the job was started.

modified date-timerequired

The time of the last update to the job.

name string

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

userCanDelete boolean

Default value: true

Is the job a regular backup job, if so is the user allowed to delete the backup file. Since this is an upload job it remains as false.

isPartial boolean

Default value: false

Is the job a regular backup job, if so is it partial. Since this is an upload job it remains as false.

backupType string

Possible values: [UPLOADED, AUTOMATED, MANUAL]

What kind of backup is this being treated as.

hydrationStatus string

Possible values: [HYDRATED, NOT_HYDRATED]

have the objects contained in the upload file been hydrated.

• ]

Example (from schema)

[
  {
    "jobId": "3469b87d-48ca-439a-868f-2160001da8c1",
    "status": "COMPLETE",
    "type": "BACKUP",
    "tenant": "uploaderTenant",
    "requesterName": "support",
    "created": "2021-05-11T22:23:16Z",
    "modified": "2021-05-11T22:23:16Z",
    "name": "A_NEW_UPLOADED_BACKUP",
    "userCanDelete": false,
    "isPartial": false,
    "backupType": "UPLOADED",
    "hydrationStatus": "NOT_HYDRATED"
  }
]

Example

[
  {
    "jobId": "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b",
    "status": "FAILED",
    "type": "BACKUP",
    "tenant": "someTenant",
    "message": "com.sailpoint.sp.config.exception.IncorrectBackupUploadFormatException: Uploaded backup file could not be parsed to correct format.",
    "requesterName": "support",
    "fileExists": false,
    "created": "2024-04-04T17:29:16.904Z",
    "modified": "2024-04-04T17:29:17.076Z",
    "name": "dfs",
    "userCanDelete": false,
    "isPartial": false,
    "backupType": "UPLOADED",
    "hydrationStatus": "NOT_HYDRATED",
    "totalObjectCount": 0
  },
  {
    "jobId": "281d421c-0643-4004-9fe5-29a95d2f73df",
    "status": "COMPLETE",
    "type": "BACKUP",
    "tenant": "someTenant",
    "requesterName": "support",
    "fileExists": true,
    "created": "2024-03-07T21:11:00.375Z",
    "modified": "2024-03-07T21:11:25.046Z",
    "completed": "2024-03-07T21:11:00.66Z",
    "name": "test1",
    "userCanDelete": false,
    "isPartial": false,
    "backupType": "UPLOADED",
    "hydrationStatus": "HYDRATED",
    "totalObjectCount": 64
  },
  {
    "jobId": "4831ad5c-f6cf-42a6-a191-8c4abec30006",
    "status": "COMPLETE",
    "type": "BACKUP",
    "tenant": "someTenant",
    "requesterName": "support",
    "fileExists": true,
    "created": "2024-02-26T18:19:26.312Z",
    "modified": "2024-02-26T18:19:40.773Z",
    "completed": "2024-02-26T18:19:26.545Z",
    "name": "testing Daniel",
    "userCanDelete": false,
    "isPartial": false,
    "backupType": "UPLOADED",
    "hydrationStatus": "HYDRATED",
    "totalObjectCount": 64
  },
  {
    "jobId": "2ea830f3-2b14-4772-8a20-3d006742e419",
    "status": "COMPLETE",
    "type": "BACKUP",
    "tenant": "someTenant",
    "requesterName": "support",
    "fileExists": true,
    "created": "2024-02-20T22:08:31.064Z",
    "modified": "2024-02-20T22:13:15.662Z",
    "completed": "2024-02-20T22:08:31.689Z",
    "name": "something new",
    "userCanDelete": false,
    "isPartial": false,
    "backupType": "UPLOADED",
    "hydrationStatus": "HYDRATED",
    "totalObjectCount": 2
  },
  {
    "jobId": "473b5cef-90e4-4cb3-ad43-7671c17d3a46",
    "status": "COMPLETE",
    "type": "BACKUP",
    "tenant": "someTenant",
    "requesterName": "support",
    "fileExists": true,
    "created": "2024-02-19T21:30:07.947Z",
    "modified": "2024-02-19T21:31:01.65Z",
    "completed": "2024-02-19T21:30:08.195Z",
    "name": "test upload",
    "userCanDelete": false,
    "isPartial": false,
    "backupType": "UPLOADED",
    "hydrationStatus": "HYDRATED",
    "totalObjectCount": 2
  },
  {
    "jobId": "09491993-9cb6-49a7-8d37-8bef54d33502",
    "status": "COMPLETE",
    "type": "BACKUP",
    "tenant": "someTenant",
    "requesterName": "support",
    "fileExists": true,
    "created": "2024-02-19T19:54:15.373Z",
    "modified": "2024-02-19T20:39:00.341Z",
    "completed": "2024-02-19T19:54:15.605Z",
    "name": "Testing Daniel",
    "userCanDelete": false,
    "isPartial": false,
    "backupType": "UPLOADED",
    "hydrationStatus": "HYDRATED",
    "totalObjectCount": 2
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...