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-sites API

DpSiteController API /dp-sites/

XSKY dp-sites 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-sites. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 19 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.

8 operations 5 paths 19 schemas 1 DELETE5 GET1 PATCH1 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-sites 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 8

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

dp-sites 8

DpSiteController API /dp-sites/

GET
/dp-sites/
List data protection sites
ListDpSites 5 params → 200500
POST
/dp-sites/
Create a data protection site
CreateDpSite 1 param → 201400409500
GET
/dp-sites/{site_id}
Get data protection site
GetDpSite 1 param → 200500
DELETE
/dp-sites/{site_id}
Delete data protection site
DeleteDpSite 1 param → 204404409500
PATCH
/dp-sites/{site_id}
Update a data protection site
UpdateDpSite 2 params → 200400404409500
GET
/dp-sites/{site_id}/backup-block-snapshots
List snapshots of a volume stored on a dp site
GetBackupBlockSnapshots 5 params → 200400403404500
GET
/dp-sites/{site_id}/backup-block-volumes
List volumes of a cluster stored on a dp site
GetBackupBlockVolumes 4 params → 200400403404500
GET
/dp-sites/{site_id}/backup-clusters
List clusters stored on a dp site
GetBackupClusters 2 params → 200400403404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are DpSite (12 properties), SnapshotBackupConfig (9 properties), DpSiteCreateReq_Site (8 properties), DpBackupBlockVolume (4 properties). Each schema is shown below with its type and property counts.

DpBackupBlockSnapshotsResp
object
1 property 1 required
DpBackupCluster
object
DpBackupCluster is a cluster stored on a site
2 properties
DpBackupBlockSnapshot
object
DpBackupBlockSnapshot is a block snapshot stored on a site
4 properties
CryptoKey_Nestview
object
2 properties
DpSiteConfig
object
DpSiteConfig contains config of different sites in dpg
3 properties
DpBackupClustersResp
object
1 property 1 required
DpSiteCreateReq_Site
object
8 properties 5 required
SnapshotBackupConfig
object
SnapshotBackupConfig contains config for snapshot backup
9 properties
RemoteCluster_Nestview
object
4 properties
DpSiteUpdateReq_Site
object
2 properties
DpSitesResp
object
1 property 1 required
BlockReplicationConfig
object
BlockReplicationConfig contains config for block replication
3 properties
SnapshotReplicationConfig
object
SnapshotReplicationConfig contains config for snapshot replication
1 property
DpSiteCreateReq
object
1 property
DpBackupBlockVolumesResp
object
1 property 1 required
DpSiteResp
object
1 property 1 required
DpBackupBlockVolume
object
DpBackupBlockVolume is a block volume stored on a site
4 properties
DpSite
object
DpSite is a site to storage data protection data
12 properties
DpSiteUpdateReq
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-dp-sites-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