NimbusNexus V1:cinder:backup API
The v1:cinder:backup API from NimbusNexus — 10 operation(s) for v1:cinder:backup.
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/nimbusnexus:nimbusnexus-v1-cinder-backup-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: NimbusNexus API — External V1:cinder:backup API
description: 'External (public) API intended for client-facing integrations and the web portal.
Authentication:
- This API uses JWT Bearer authentication.
- In Swagger UI, click ''Authorize'' and sign in via the configured token endpoint.
- Swagger will automatically attach the header: Authorization: Bearer .'
version: test
servers:
- url: /
description: Current host
- url: https://fastapi.dev.nimbusnexus.net
description: Development
security:
- SwaggerLogin: []
- ApiKeyAuth: []
tags:
- name: v1:cinder:backup
paths:
/api/v1/backup_restore/volume_backups/run_job_single:
post:
tags:
- v1:cinder:backup
summary: Volume Backup Run Trigger By Specific Conf
operationId: volume_backup_run_trigger_by_specific_conf_api_v1_backup_restore_volume_backups_run_job_single_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunJobSpecificConfig'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/backup_restore/volume_backups/schedule_job:
post:
tags:
- v1:cinder:backup
summary: Volume Backup Run Trigger By Schedule
description: Triggers the volume backup scheduler job for the requested frequency to evaluate due schedules.
operationId: volume_backup_run_trigger_by_schedule_api_v1_backup_restore_volume_backups_schedule_job_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeBackupJob'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/backup_restore/volume_backups/backup_restore:
post:
tags:
- v1:cinder:backup
summary: Run Backup Restore Queue Job
description: Queues a job that restores a completed volume backup back into a block storage volume.
operationId: run_backup_restore_queue_job_api_v1_backup_restore_volume_backups_backup_restore_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeRestore'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Not Found
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Conflict
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/backup_restore/volume_backups/snapshot_restore:
post:
tags:
- v1:cinder:backup
summary: Run Snapshot Restore Queue Job
description: Queues a job that restores a completed snapshot-type backup into a block storage volume.
operationId: run_snapshot_restore_queue_job_api_v1_backup_restore_volume_backups_snapshot_restore_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeRestore'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/backup_restore/volume_backups/create_backup:
post:
tags:
- v1:cinder:backup
summary: Create Volume Backup Run Trigger
description: Queues a job that creates a new backup of a block storage volume after validating the project's quota.
operationId: create_volume_backup_run_trigger_api_v1_backup_restore_volume_backups_create_backup_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeBackupOutsideCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/backup_restore/volume_backups/upload_exist:
post:
tags:
- v1:cinder:backup
summary: Upload Existing Volume Backup To Outside Storage
description: Queues jobs to upload an existing completed volume backup into one or more external storage destinations.
operationId: upload_existing_volume_backup_to_outside_storage_api_v1_backup_restore_volume_backups_upload_exist_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeBackupOutsideUpload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/backup_restore/volume_backups/{volume_backup_id}:
patch:
tags:
- v1:cinder:backup
summary: Update Volume Backup
description: Updates the editable attributes of an existing volume backup record.
operationId: update_volume_backup_api_v1_backup_restore_volume_backups__volume_backup_id__patch
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: volume_backup_id
in: path
required: true
schema:
type: string
title: Volume Backup Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeBackupUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeBackupSuccessOut'
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'404':
description: Not Found
content:
application/json:
example:
success: false
message: Not Found
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
/api/v1/backup_restore/volume_backups/bulk:
delete:
tags:
- v1:cinder:backup
summary: Delete Volume Backup Bulk
description: Deletes multiple volume backups in one call, removing them from block storage and any external storage destinations.
operationId: delete_volume_backup_bulk_api_v1_backup_restore_volume_backups_bulk_delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: backup_ids
in: query
required: true
schema:
type: array
items:
type: string
title: Backup Ids
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'404':
description: Not Found
content:
application/json:
example:
success: false
message: Not Found
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
/api/v1/backup_restore/volume_backups/single/{volume_backup_id}:
delete:
tags:
- v1:cinder:backup
summary: Delete Volume Backup
description: Deletes a single volume backup from block storage and any associated external storage destinations.
operationId: delete_volume_backup_api_v1_backup_restore_volume_backups_single__volume_backup_id__delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: volume_backup_id
in: path
required: true
schema:
type: string
title: Volume Backup Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'404':
description: Not Found
content:
application/json:
example:
success: false
message: Not Found
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
/api/v1/backup_restore/volume_backups/:
get:
tags:
- v1:cinder:backup
summary: List Volume Backups
description: Lists volume backups for the project's volumes with filtering by status and type plus pagination and sorting.
operationId: list_volume_backups_api_v1_backup_restore_volume_backups__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 0
- type: 'null'
default: 10
title: Limit
- name: offset
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 0
- type: 'null'
default: 0
title: Offset
- name: statuses
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Statuses
- name: backup_types
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Backup Types
- name: sort_by
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sort By
- name: sort_desc
in: query
required: false
schema:
type: boolean
default: false
title: Sort Desc
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeBackupSuccessOutList'
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'404':
description: Not Found
content:
application/json:
example:
success: false
message: Not Found
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
components:
schemas:
VolumeBackupJob:
properties:
frequency:
type: string
enum:
- daily
- weekly
- monthly
title: Frequency
type: object
required:
- frequency
title: VolumeBackupJob
website__model__website__volume_backup__volume_backup__BackupTypeEnum:
type: string
enum:
- snapshot
- backup
title: BackupTypeEnum
VolumeBackupOutsideUpload:
properties:
backup_id:
type: string
title: Backup Id
storage_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Storage Ids
default: []
type: object
required:
- backup_id
title: VolumeBackupOutsideUpload
BackupStatusEnum:
type: string
enum:
- pending
- in_progress
- completed
- failed
title: BackupStatusEnum
VolumeBackupUpdate:
properties:
status:
anyOf:
- $ref: '#/components/schemas/BackupStatusEnum'
- type: 'null'
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
volume_id:
anyOf:
- type: string
- type: 'null'
title: Volume Id
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
permanent:
anyOf:
- type: boolean
- type: 'null'
title: Permanent
type: object
title: VolumeBackupUpdate
VolumeBackupSuccessOutList:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/VolumeBackupRead'
type: array
title: Data
total:
type: integer
title: Total
type: object
required:
- data
- total
title: VolumeBackupSuccessOutList
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
VolumeRestore:
properties:
backup_id:
type: string
title: Backup Id
type: object
required:
- backup_id
title: VolumeRestore
ResponseBaseErrorOut:
properties:
success:
type: boolean
title: Success
default: false
message:
type: string
title: Message
type: object
required:
- message
title: ResponseBaseErrorOut
RunJobSpecificConfig:
properties:
config_id:
type: string
title: Config Id
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
default: ''
permanent:
anyOf:
- type: boolean
- type: 'null'
title: Permanent
default: false
type: object
required:
- config_id
- name
title: RunJobSpecificConfig
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
VolumeBackupSuccessOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/VolumeBackupRead'
type: object
required:
- data
title: VolumeBackupSuccessOut
ResponseValidationErrorOut:
properties:
success:
type: boolean
title: Success
default: false
errors:
additionalProperties:
items:
type: string
type: array
type: object
title: Errors
type: object
required:
- errors
title: ResponseValidationErrorOut
VolumeBackupOutsideCreate:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
schedule_id:
anyOf:
- type: string
- type: 'null'
title: Schedule Id
schedule_config_id:
anyOf:
- type: string
- type: 'null'
title: Schedule Config Id
location_url:
anyOf:
- type: string
- type: 'null'
title: Location Url
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
storage_type:
anyOf:
- type: string
maxLength: 50
- type: 'null'
title: Storage Type
region:
anyOf:
- type: string
maxLength: 50
- type: 'null'
title: Region
volume_id:
type: string
title: Volume Id
type:
$ref: '#/components/schemas/website__model__website__volume_backup__volume_backup__BackupTypeEnum'
storage_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Storage Ids
default: []
status:
allOf:
- $ref: '#/components/schemas/BackupStatusEnum'
default: pending
permanent:
type: boolean
title: Permanent
default: false
type: object
required:
- volume_id
- type
title: VolumeBackupOutsideCreate
VolumeBackupRead:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
schedule_id:
anyOf:
- type: string
- type: 'null'
title: Schedule Id
schedule_config_id:
anyOf:
- type: string
- type: 'null'
title: Schedule Config Id
location_url:
anyOf:
- type: string
- type: 'null'
title: Location Url
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
storage_type:
anyOf:
- type: string
maxLength: 50
- type: 'null'
title: Storage Type
region:
anyOf:
- type: string
maxLength: 50
- type: 'null'
title: Region
id:
type: string
title: Id
volume_id:
type: string
title: Volume Id
storage_id:
anyOf:
- type: string
- type: 'null'
title: Storage Id
type:
$ref: '#/components/schemas/website__model__website__volume_backup__volume_backup__BackupTypeEnum'
status:
$ref: '#/components/schemas/BackupStatusEnum'
permanent:
type: boolean
title: Permanent
created_at:
type: string
format: date-time
title: Created At
updated_at:
type: string
format: date-time
title: Updated At
type: object
required:
- id
- volume_id
- type
- status
- permanent
- created_at
- updated_at
title: VolumeBackupRead
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
SwaggerLogin:
type: oauth2
flows:
password:
tokenUrl: /api/v1/account/login_swagger
scopes: {}
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API Key format - base64('<id>:<secret>')