Backup Providers

Add a new backup provider

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.

post/backup-providers

Request

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

Request body

type'aws_s3' | 'azure' | 'cloudpepper' | 'google_cloud' | 's3' | 'sftp' required

The type of backup provider

credentialIdstring uuid

Optional ID of existing credentials to use

secretstring

Authentication secret for the provider (required if credentialId is not provided)

configobject

Provider-specific configuration parameters

Response

Backup provider successfully added

Changes

No recorded changes to this operation across all 1 revision of this API.