# Backup Status Badge

Backup Status Badge is a feature that allows you to display the backup status of your repositories on your repository page. The badge will show the last backup status for the repository. This feature is useful for repository owners to keep track of the backup status of their repositories.

## About Backup Status Badge

The badge represents the status of the latest backup created by Cloudback. The badge can be embedded into any web page.

You can find a sample usage in the Cloudback's Terraform Provider repository home page: <https://github.com/cloudback/terraform-provider-cloudback#readme>

## How to get the Backup Status Badge

To get the Backup Status Badge for your repository, follow these steps:

* Go to the Cloudback Dashboard
* Open the repository details page for the repository you want to get the badge for
* In the `Settings` section, click on the `Get badge URL` button:

![Get backup status badge](https://2781059148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQEI7SjBF2CddqNXZpCoE%2Fuploads%2Fgit-blob-76406943bfeeb94ac7e05fee6792c4b444ac248f%2Fget-backup-status-badge.png?alt=media)

After you clicked on the `Get badge URL` button, you will see a modal with the badge URL. You can copy the URL and use it to embed the badge into your web page. There are two options available, you can copy the image URL or the Markdown code:

![Backup status badge dialog](https://2781059148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQEI7SjBF2CddqNXZpCoE%2Fuploads%2Fgit-blob-0992f06a17c964996f82bd2bc093544542e48001%2Fbackup-status-badge-dialog.png?alt=media)

## Badge URL Formats

Cloudback supports two badge URL formats:

* **Multi-platform (current)**: `/badge/{platform}/{accountIdentifier}/{subjectType}/{subjectName}` - works for all supported platforms.
* **Legacy GitHub-only**: `/badge/{owner}/{repositoryName}` - supported for backwards compatibility.

## Badge Status Values

The badge reflects the status of the latest backup. The following statuses are possible:

| Status      | Color | Description                                     |
| ----------- | ----- | ----------------------------------------------- |
| succeeded   | green | The last backup completed successfully          |
| failed      | red   | The last backup failed                          |
| in progress | green | A backup is currently running                   |
| scheduled   | green | A backup is queued and waiting to run           |
| deleted     | grey  | The repository or backup definition was deleted |
| unknown     | grey  | Status could not be determined                  |

## Learn More

* [Dashboard Overview](https://docs.cloudback.it/dashboard/dashboard-overview)
* [Repository Details](https://docs.cloudback.it/dashboard/repository-details)