Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

XSKY dp-block-snapshot-recovery-jobs API

DpBlockSnapshotRecoveryJobController API /dp-block-snapshot-recovery-jobs

XSKY dp-block-snapshot-recovery-jobs API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include dp-block-snapshot-recovery-jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 2.0, at version SDS_4.2.000.0.200302.

Requests are made against the base URL https://{xms-controller}/v1.

4 operations 2 paths 15 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
SDS_4.2.000.0.200302
Base URL
https://{xms-controller}/v1
Authentication
API Key, API Key
License
Commercial
Resource Areas
1

Authentication & Security 2

XSKY dp-block-snapshot-recovery-jobs API declares 2 security schemes for authenticating requests. An API key is passed in the header as Xms-Auth-Token (tokenInHeader). An API key is passed in the query as token (tokenInQuery).

  • tokenInHeader — auth by token
  • tokenInQuery — auth by token

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

dp-block-snapshot-recovery-jobs 4

DpBlockSnapshotRecoveryJobController API /dp-block-snapshot-recovery-jobs

GET
/dp-block-snapshot-recovery-jobs/
List dp block snapshot recovery jobs
ListDpBlockSnapshotRecoveryJobs 4 params → 200400500
POST
/dp-block-snapshot-recovery-jobs/
Create a dp block snapshot recovery job
CreateDpBlockSnapshotRecoveryJob 1 param → 202400500
GET
/dp-block-snapshot-recovery-jobs/{job_id}
Get a dp block snapshot recovery job
GetDpBlockSnapshotRecoveryJob 1 param → 200400404500
DELETE
/dp-block-snapshot-recovery-jobs/{job_id}
Delete a dp block snapshot recovery job
DeleteDpBlockSnapshotRecoveryJob 1 param → 204400404409500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are DpBlockSnapshotRecoveryJob (16 properties), DpBlockSnapshotRecoveryJobCreateReq_Job (7 properties), DpBackupBlockSnapshot (4 properties), DpBackupBlockVolume (4 properties). Each schema is shown below with its type and property counts.

DpBlockSnapshotRecoveryJobCreateReq_Job_BackupCluster
object
2 properties 2 required
DpBlockSnapshotRecoveryJobsResp
object
1 property
DpBlockSnapshotRecoveryJob
object
DpBlockSnapshotRecoveryJob recovery a block resource
16 properties
DpBlockSnapshotRecoveryJobCreateReq
object
1 property 1 required
DpBlockSnapshotRecoveryJobCreateReq_Job
object
7 properties 7 required
DpBlockSnapshotRecoveryJobCreateReq_Job_Volume
object
3 properties 2 required
DpBackupCluster
object
DpBackupCluster is a cluster stored on a site
2 properties
DpBlockSnapshotRecoveryJobCreateReq_Job_BackupSnapshot
object
2 properties 2 required
DpBackupBlockSnapshot
object
DpBackupBlockSnapshot is a block snapshot stored on a site
4 properties
DpBackupBlockVolume
object
DpBackupBlockVolume is a block volume stored on a site
4 properties
DpBlockSnapshotRecoveryJobResp
object
1 property
DpBlockSnapshotRecoveryJobCreateReq_Job_BackupVolume
object
2 properties 2 required
DpSite_Nestview
object
2 properties
Volume_Nestview
object
3 properties
DpGateway_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-dp-block-snapshot-recovery-jobs-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

XSKY access-paths API
XSKY access-tokens API
XSKY action-logs API
XSKY alert-groups API
XSKY alert-rules API
XSKY alerts API
XSKY auth API
XSKY block-snapshots API
XSKY block-volume-group-snapshots API
XSKY block-volume-groups API
XSKY block-volume-migration-jobs API
XSKY block-volumes API