---
title: "Add a new backup provider"
method: POST
path: "/backup-providers"
tags: ["Backup Providers"]
---

# Add a new backup provider

`POST /backup-providers`

## Request

- Base URL: `https://api.cloudpepper.io`
- URL: `https://api.cloudpepper.io/backup-providers`
- Auth: HTTP bearer

Creates a new backup provider with the specified configuration. This endpoint supports various storage types including AWS S3, Azure Storage, Google Cloud Storage, S3-compatible storage, SFTP, and internal cloudpepper storage. The provider will be validated before being added to ensure connectivity and proper configuration.

**Key Parameters:**
- `type`: The storage provider type (e.g., 'aws_s3', 'azure', 'cloudpepper', 'google_cloud', 's3', 'sftp')
- `secret`: Authentication secret for the provider (e.g., AWS secret key, SFTP password/key)
- `config`: Provider-specific configuration parameters

**NOTE:** After adding a backup provider, you can use it to store backups of your Odoo instances. You can set a provider as the default for automatic backups via the set-default endpoint.

## Request body

- object
  - `type` 'aws_s3' | 'azure' | 'cloudpepper' | 'google_cloud' | 's3' | 'sftp', required: The type of backup provider
  - `credentialId` string, uuid: Optional ID of existing credentials to use
  - `secret` string: Authentication secret for the provider (required if credentialId is not provided)
  - `config` object: Provider-specific configuration parameters

## Response `200`

Backup provider successfully added

## Other responses

- `400`: Invalid credentials or configuration
- `403`: Insufficient permissions

---

[API](https://skmtc.dev/cloudpepper/apis/cloudpepper-api-docs.md) · [All operations](https://skmtc.dev/cloudpepper/apis/cloudpepper-api-docs/llms.txt) · [OpenAPI document](https://skmtc.dev/cloudpepper/apis/cloudpepper-api-docs/revisions/b6a59274cedc?raw)