Cloudpepper Backups API
The Backups API from Cloudpepper — 3 operation(s) for backups.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudpepper-io:cloudpepper-io-backups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Cloudpepper Io Backups API
version: 1.0.0
description: 'Operations tagged Backups across 2 of this provider''s published API definitions: cloudpepper-io-openapi.json, cloudpepper-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
- url: https://api.cloudpepper.io
description: Resolved from the published relative server "/" against the host serving the spec (https://api.cloudpepper.io/openapi.json)
security:
- bearerAuth: []
tags:
- name: Backups
paths:
/backups:
get:
tags:
- Backups
summary: List all backups
description: 'Retrieves a list of all backups for your account. This endpoint returns comprehensive information about each backup, including when it was created, its size, status, and the instance it belongs to. This data can be used for monitoring your backup history, verifying backup completion, and managing your backup storage.
**The response includes:**
- Unique backup identifier
- Backup status (complete, pending, error, etc.)
- Completion timestamp
- Backup size in bytes
- Instance ID (if the backup is associated with an instance, may be null)'
operationId: app_api_getbackups
responses:
'200':
description: Backups retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Backup'
example:
- id: 0194dbaf-9b09-7d54-9621-00a59f58046d
status: complete
completedAt: '2025-02-06T14:35:30+00:00'
size: 1115479
instanceId: null
notes: Pre-migration backup
- id: 01958aa4-21ad-7deb-a3b7-1c5eb5bcaab2
status: complete
completedAt: '2025-03-12T13:56:29+00:00'
size: 3346652
instanceId: null
notes: Pre-migration backup
- id: 0195cc49-6cb3-718e-86af-b7213b5ff6ca
status: complete
completedAt: '2025-03-25T07:52:24+00:00'
size: 2231239
instanceId: null
notes: Pre-migration backup
- id: 0195eb6e-9680-70e8-b90c-2df394a153ad
status: complete
completedAt: '2025-03-31T09:01:16+00:00'
size: 2558044
instanceId: null
notes: Pre-migration backup
- id: 0195ebc7-4330-74ef-931e-3b26cb17a0fb
status: complete
completedAt: '2025-03-31T10:37:57+00:00'
size: 2486360
instanceId: null
notes: Pre-migration backup
- id: 0195ebf1-9dfa-7b0d-a663-06c868c1d5c1
status: complete
completedAt: '2025-03-31T11:24:12+00:00'
size: 2558040
instanceId: null
notes: Pre-migration backup
- id: 0195efb6-decf-7d01-a10e-68a301bb0c92
status: complete
completedAt: '2025-04-01T04:58:35+00:00'
size: 1115314
instanceId: null
notes: Pre-migration backup
'403':
description: Insufficient permissions (requires admin privileges)
security:
- bearerAuth: []
servers:
- url: /
/backup-usage:
parameters:
- name: from
in: query
description: 'Start date for the usage data range (format: YYYY-MM-DD)'
required: true
schema:
type: string
format: date
- name: to
in: query
description: 'End date for the usage data range (format: YYYY-MM-DD)'
required: true
schema:
type: string
format: date
get:
tags:
- Backups
summary: Get backup storage usage
description: 'Retrieves historical backup storage usage data for your account within a specified date range. This endpoint provides detailed insights into how your backup storage consumption has changed over time, which is useful for monitoring, planning, and cost management. The data returned includes daily storage usage values measured in bytes.
**Key Parameters:**
- `from`: Start date for the usage data range (format: YYYY-MM-DD)
- `to`: End date for the usage data range (format: YYYY-MM-DD)
**NOTE:** This endpoint requires administrator privileges. The date range should typically be within reasonable limits (e.g., 1-3 months) for optimal performance. Very large date ranges may impact response time.'
responses:
'200':
description: Backup usage data retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Quota'
example:
- date: '2023-01-01'
value: 1073741824
- date: '2023-01-02'
value: 1288490188
- date: '2023-01-03'
value: 1288490188
'403':
description: Insufficient permissions - requires administrator privileges
operationId: getBackupUsage
x-operation-id-source: derived
servers:
- url: /
/backups/{id}:
parameters:
- name: id
in: path
description: Backup id
required: true
schema:
type: string
patch:
tags:
- Backups
summary: Update backup properties
description: 'Updates specific properties of a backup such as notes. This endpoint allows you to add or modify notes for your backups to help organize and document your backup history. Notes are useful for tracking the purpose of a backup, what changes were included, or any other relevant information.
**Key Parameters:**
- `id`: The unique identifier of the backup to update
- `notes`: Optional text field to add or update notes for the backup
**NOTE:** Changes are applied immediately to the backup record.'
requestBody:
content:
application/json:
schema:
type: object
properties:
notes:
type: string
description: Notes to add or update for the backup
example: Pre-migration backup with custom modules installed
required: true
responses:
'200':
description: Backup updated successfully
content:
application/json:
schema:
type: string
example: ok
'403':
description: Insufficient permissions - requires edit permissions
'404':
description: Backup not found
security:
- bearerAuth: []
operationId: patchBackupsById
x-operation-id-source: derived
delete:
tags:
- Backups
summary: Delete backup
description: 'Permanently deletes a specific backup from your account. This endpoint initiates the deletion process by setting the backup status to DELETING and starts the underlying process of backup deletion. This is useful for removing old or unnecessary backups to free up storage space and maintain your backup archive.
**Key Parameters:**
- `id`: The unique identifier of the backup to delete
**NOTE:** This is a permanent operation and cannot be undone. Once deleted, the backup data will be completely removed from storage, and recovery will not be possible. Make sure you no longer need the backup before proceeding with deletion.'
responses:
'200':
description: Backup deletion process initiated successfully
'403':
description: Insufficient permissions - requires edit permissions
'500':
description: Backup not found
operationId: deleteBackupsById
x-operation-id-source: derived
servers:
- url: /
components:
schemas:
Quota:
type: object
properties:
date:
type: string
value:
type: integer
Backup:
type: object
properties:
id:
type: string
instanceId:
type:
- string
- 'null'
format: uuid
description: ID of the instance this backup belongs to (null if the instance no longer exists)
status:
type: string
completedAt:
type: string
size:
type: integer
notes:
type:
- string
- 'null'
description: Optional notes about the backup
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-refined-from:
- cloudpepper-io-openapi.json
- cloudpepper-io-openapi.yml