---
title: "API Documentation"
canonical: "https://sesame-software-documentation.refined.site/space/bandr/386367518/API%20Documentation"
format: markdown
---
![ChatGPT Image Feb 25, 2026, 08_44_09 AM.png](media://ca2e4d0c-8053-411e-89e2-7fad3afa2f0b)

Sesame Software's Backup & Recovery platform includes a RESTful API that allows you to integrate backup and restore operations into your existing workflows, CI/CD pipelines, automation tools, or monitoring systems.

This guide outlines how to get started and provides available endpoints for managing your backup and restore jobs.

---

## 🚀 Getting Started

### 🔐 Authentication

All API requests require authentication using an API key provided in the request header:

```
makefile
```

CopyEdit

`Authorization: Bearer <your_api_key> `

You can generate or retrieve your API key from your Sesame Software admin settings.

---

## 🔗 How to Integrate with Other Tools

Sesame’s API is designed for flexibility. You can integrate with:

- Scheduling systems (e.g., cron, enterprise job schedulers)
- DevOps tools (e.g., Jenkins, GitHub Actions)
- Monitoring platforms (e.g., Datadog, New Relic)
- Custom admin dashboards or alerting workflows

By calling our endpoints, you can trigger backups, monitor job status, retrieve logs, and automate restore actions without using the UI.

---

## 📘 API Endpoints

### 🔄 Backups

| **Endpoint** | **Method** | **Description** |
| --- | --- | --- |
| `/api/backups` | `GET` | List all backup jobs |
| `/api/backups/:id` | `GET` | Get details of a specific backup job |
| `/api/backups` | `POST` | Create a new backup job |
| `/api/backups/:id/run` | `POST` | Trigger a backup run for a specific job |
| `/api/backups/:id/status` | `GET` | Get the current status of a backup run |

---

### 🔁 Restores

| **Endpoint** | **Method** | **Description** |
| --- | --- | --- |
| `/api/restores` | `GET` | List all restore jobs |
| `/api/restores/:id` | `GET` | Get details of a specific restore job |
| `/api/restores` | `POST` | Create and initiate a new restore job |
| `/api/restores/:id/status` | `GET` | Get the current status of a restore job |

---

## 🧪 Example Request: Trigger a Backup

```
bash
```

CopyEdit

`curl -X POST https://your-domain/api/backups/123/run \   -H "Authorization: Bearer YOUR_API_KEY" `

---

## ✅ Best Practices

- Use a service account with limited privileges for automation
- Monitor status endpoints to verify success/failure
- Always test restore operations in a sandbox before running in production

---