Versions Compared

Old Version 6

changes.mady.by.user Sergio Vieira

Saved on

compared with

New Version Current

changes.mady.by.user Sergio Vieira

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


There are three endpoints regarding backups of Xray information.


Generate a Backup

/api/v1/backup

Check backup job status

/api/v1/backup/{jobId}/status

Get backup file/api/v1/backup/file
Get attachment backup file/api/v1/backup/file/attachment


The first endpoint is an asynchronous call to generate a backup. Whenever this endpoint is called, a job is queued to create the backup and its id is returned. The second endpoint can be used to check the status of this job.

...

Expand
titleGET /api/v1/backup/{jobId}/status
Panel
borderColor#ccc
borderStylesolid

Get a backup job status.

Request

PATH PARAMETERS

parameter

type

description

jobIdString

- id of the generate backup job

Tip
titleExample Request
curl -H "Content-Type: application/json" -X GET -H "Authorization: Bearer $token" https://xray.cloud.xpand-it.com/api/v1/backup/34a4106b1d0948d1aae1170cc8df3bb4/status

Responses

200 OK : application/json : The status of the backup job is returned.

Code Block
titleExample Output 1
{
  "status": "wokingworking",
  "progressValue": "10%"
}
Code Block
titleExample Output 2
{
  "status": "successful",
  "fileUrl": "https://xray.cloud.xpand-it.com/api/v1/backup/file",
  "attachmentUrl": "https://xray.cloud.xpand-it.com/api/v1/backup/file/attachment"
}


404 BAD_REQUEST : application/json : No backup job with the given id was found.

Code Block
languagejs
titleExample Output
{
  "error": "job not found."
}


401 UNAUTHORIZED : application/json : The API token is not valid.


Download the backup file

Info

To download large backup files, please use version 2 of the REST API.

To download the backup file, you can use the following endpoint:

...

Download the attachment backup file

Info

To download large backup files, please use version 2 of the REST API.

To download the attachment backup file, you can use the following endpoint:

...