Cisco Crosswork

Cisco Crosswork Backup Services API

The BackupServices API from Cisco Crosswork — 13 operation(s) for backupservices.

GitHub OpenAPI

Operations 14

POST /v1/platform/backup/get #
GET /v1/platform/backup/get/tasks/{jobId} #
GET /v1/platform/backup/get/{jobId} #
POST /v1/platform/backup/init #
GET /v1/platform/backup/remote #
POST /v1/platform/backup/remote #
POST /v1/platform/backup/update #
POST /v1/platform/backup/verify #
POST /v1/platform/restore/disaster #
GET /v1/platform/restore/get/tasks/{jobId} #
GET /v1/platform/restore/get/{jobId} #
POST /v1/platform/restore/init #
POST /v1/platform/restore/verify #
POST /v2/platform/migration #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cisco-crosswork/refs/heads/main/openapi/cisco-crosswork-backupservices-api-openapi.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cisco-crosswork-backupservices-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

cisco-crosswork-backupservices-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: backup.proto Backup Services API
  version: version not set
  x-provenance:
    method: harvested
    authored_by: Cisco Crosswork
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/NCAHI/4.0APIs/backup.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/NCAHI/4.0APIs/backup.swagger.json
tags:
- name: BackupServices
paths:
  /v1/platform/backup/get:
    post:
      operationId: RequestJobsBackupRestore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupGetJobsResult'
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupGetJobsReq'
        required: true
  /v1/platform/backup/get/tasks/{jobId}:
    get:
      operationId: RequestTasksBackupRestore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupGetTasksResult'
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      tags:
      - BackupServices
  /v1/platform/backup/get/{jobId}:
    get:
      operationId: RequestJobDetailsBackupRestore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupGetJobResult'
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      tags:
      - BackupServices
  /v1/platform/backup/init:
    post:
      operationId: RequestVMBackup
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupBackupOpResult'
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupBackUpOpReq'
        required: true
  /v1/platform/backup/remote:
    get:
      operationId: GetVMBackupRemoteLocation
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupRequestVMBackupRemoteLocationOp'
      tags:
      - BackupServices
    post:
      operationId: RequestVMBackupRemoteLocation
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                properties: {}
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupRequestVMBackupRemoteLocationOp'
        required: true
  /v1/platform/backup/update:
    post:
      operationId: RequestVMBackupRestoreJobNames
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                properties: {}
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupRequestVMBackupRestoreJobNamesOp'
        required: true
  /v1/platform/backup/verify:
    post:
      operationId: RequestVMBackupVerify
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupBackupVerifyOpResult'
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              properties: {}
        required: true
  /v1/platform/restore/disaster:
    post:
      operationId: RequestVMDisasterRestore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupBackupOpResult'
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupDisasterRestoreOpReq'
        required: true
  /v1/platform/restore/get/tasks/{jobId}:
    get:
      operationId: RequestTasksRestore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupGetTasksResult'
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      tags:
      - BackupServices
  /v1/platform/restore/get/{jobId}:
    get:
      operationId: RequestJobDetailsRestore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupGetJobResult'
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      tags:
      - BackupServices
  /v1/platform/restore/init:
    post:
      operationId: RequestVMRestore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupBackupOpResult'
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupRestoreOpReq'
        required: true
  /v1/platform/restore/verify:
    post:
      operationId: RequestVMRestoreVerify
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupBackupVerifyOpResult'
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupRestoreVerifyOpReq'
        required: true
  /v2/platform/migration:
    post:
      operationId: RequestMigration
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/backupBackupOpResult'
      tags:
      - BackupServices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/backupMigrationOpReq'
        required: true
components:
  schemas:
    backupGetTaskResult:
      type: object
      properties:
        taskId:
          type: string
        taskName:
          type: string
        jobId:
          type: string
        timeInitiated:
          type: string
        timeCompleted:
          type: string
        status:
          type: string
    backupMigrationOpReq:
      type: object
      properties:
        filename:
          type: string
        force:
          type: boolean
          format: boolean
    backupBackupVerifyOpResult:
      type: object
      properties:
        warnings:
          type: array
          items:
            type: string
    backupGetJobResult:
      type: object
      properties:
        jobId:
          type: string
        jobName:
          type: string
        jobType:
          type: string
        timeInitiated:
          type: string
        lastCompletedAction:
          type: string
        currentActionInProgress:
          type: string
        timeCompleted:
          type: string
        status:
          type: string
        backupJobId:
          type: string
        backupJobName:
          type: string
        error:
          type: string
    backupRestoreVerifyOpReq:
      type: object
      properties:
        backupJobName:
          type: string
        force:
          type: boolean
          format: boolean
    backupBackUpOpReq:
      type: object
      properties:
        jobName:
          type: string
        force:
          type: boolean
          format: boolean
        nsoBackupDisable:
          type: boolean
          format: boolean
    backupRequestVMBackupRestoreJobNamesOp:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/backupRequestVMBackupRestoreJobNameOp'
    backupGetJobsResult:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/backupGetJobResult'
    backupDisasterRestoreOpReq:
      type: object
      properties:
        filename:
          type: string
        force:
          type: boolean
          format: boolean
    backupGetJobsReq:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/backupGetJobsReqFilter'
        filterData:
          $ref: '#/components/schemas/backupGetJobsReqPageFilter'
    backupRestoreOpReq:
      type: object
      properties:
        jobName:
          type: string
        backupJobName:
          type: string
        force:
          type: boolean
          format: boolean
    backupGetJobsReqPageFilter:
      type: object
      properties:
        status:
          type: string
        jobType:
          type: string
        jobName:
          type: string
    backupGetTasksResult:
      type: object
      properties:
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/backupGetTaskResult'
    backupGetJobsReqFilter:
      type: object
      properties:
        pageSize:
          type: integer
          format: int32
        pageNum:
          type: integer
          format: int32
    backupRequestVMBackupRemoteLocationOp:
      type: object
      properties:
        hostName:
          type: string
        port:
          type: integer
          format: int32
        username:
          type: string
        password:
          type: string
        remotePath:
          type: string
    backupBackupOpResult:
      type: object
      properties:
        jobId:
          type: string
    backupRequestVMBackupRestoreJobNameOp:
      type: object
      properties:
        jobId:
          type: string
        jobName:
          type: string