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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/nimbusnexus:nimbusnexus-v1-cinder-backup-scheduler-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.

GitHub Google LinkedIn

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:scheduler 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:scheduler
paths:
  /api/v1/backup_restore/backup_scheduler/:
    post:
      tags:
      - v1:cinder:backup:scheduler
      summary: Create Backup Schedule
      description: Creates a recurring backup schedule for block storage volumes after validating the project's backup quota.
      operationId: create_backup_schedule_api_v1_backup_restore_backup_scheduler__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupScheduleCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupScheduleSuccessOut'
        '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
        '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/backup_scheduler/{backup_schedule_id}:
    patch:
      tags:
      - v1:cinder:backup:scheduler
      summary: Update Backup Schedule
      description: Updates an existing block storage backup schedule and revalidates quota when the retention is increased.
      operationId: update_backup_schedule_api_v1_backup_restore_backup_scheduler__backup_schedule_id__patch
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: backup_schedule_id
        in: path
        required: true
        schema:
          type: string
          title: Backup Schedule Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupScheduleUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupScheduleSuccessOut'
        '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'
    delete:
      tags:
      - v1:cinder:backup:scheduler
      summary: Delete Backup Schedule
      description: Deletes a block storage backup schedule by its ID.
      operationId: delete_backup_schedule_api_v1_backup_restore_backup_scheduler__backup_schedule_id__delete
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: backup_schedule_id
        in: path
        required: true
        schema:
          type: string
          title: Backup Schedule Id
      responses:
        '204':
          description: Successful Response
        '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/backup_scheduler/list:
    get:
      tags:
      - v1:cinder:backup:scheduler
      summary: Get Backup Schedule List
      description: Lists block storage backup schedules in the current domain with pagination, sorting and frequency filtering.
      operationId: get_backup_schedule_list_api_v1_backup_restore_backup_scheduler_list_get
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
      parameters:
      - name: offset
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Offset
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - 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
      - name: frequency
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Frequency
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupScheduleSuccessOutList'
        '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'
        '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:
    BackupScheduleCreate:
      properties:
        frequency:
          allOf:
          - $ref: '#/components/schemas/BackupFrequencyEnum'
          default: daily
        backup_quantity:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Backup Quantity
          default: 5
        outside_backup_quantity:
          anyOf:
          - type: integer
          - type: 'null'
          title: Outside Backup Quantity
          default: 1
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
          default: true
        domain_id:
          anyOf:
          - type: string
            maxLength: 50
          - type: 'null'
          title: Domain Id
      type: object
      title: BackupScheduleCreate
    BackupScheduleUpdate:
      properties:
        frequency:
          anyOf:
          - $ref: '#/components/schemas/BackupFrequencyEnum'
          - type: 'null'
        backup_quantity:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Backup Quantity
        outside_backup_quantity:
          anyOf:
          - type: integer
          - type: 'null'
          title: Outside Backup Quantity
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
        domain_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Domain Id
      type: object
      title: BackupScheduleUpdate
    BackupScheduleSuccessOutList:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          items:
            $ref: '#/components/schemas/BackupScheduleRead'
          type: array
          title: Data
        total:
          type: integer
          title: Total
      type: object
      required:
      - data
      - total
      title: BackupScheduleSuccessOutList
    ResponseBaseErrorOut:
      properties:
        success:
          type: boolean
          title: Success
          default: false
        message:
          type: string
          title: Message
      type: object
      required:
      - message
      title: ResponseBaseErrorOut
    BackupScheduleSuccessOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          $ref: '#/components/schemas/BackupScheduleRead'
      type: object
      required:
      - data
      title: BackupScheduleSuccessOut
    BackupFrequencyEnum:
      type: string
      enum:
      - daily
      - weekly
      - monthly
      title: BackupFrequencyEnum
    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
    BackupScheduleRead:
      properties:
        id:
          type: string
          title: Id
        frequency:
          $ref: '#/components/schemas/BackupFrequencyEnum'
        backup_quantity:
          type: integer
          title: Backup Quantity
        outside_backup_quantity:
          type: integer
          title: Outside Backup Quantity
        enabled:
          type: boolean
          title: Enabled
        domain_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Domain Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - frequency
      - backup_quantity
      - outside_backup_quantity
      - enabled
      - created_at
      - updated_at
      title: BackupScheduleRead
  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>')