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-backup-policies API

DpBlockBackupPolicyController API /dp-block-backup-policies

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

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

5 operations 2 paths 9 schemas 1 DELETE2 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-block-backup-policies 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 5

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

dp-block-backup-policies 5

DpBlockBackupPolicyController API /dp-block-backup-policies

GET
/dp-block-backup-policies/
List dp block backup policies
ListDpBlockBackupPolicies 5 params → 200400500
POST
/dp-block-backup-policies/
Create dp block backup policy
CreateDpBlockBackupPolicy 1 param → 202400500
GET
/dp-block-backup-policies/{policy_id}
Get dp block backup policy
GetDpBlockBackupPolicy 1 param → 200400404500
DELETE
/dp-block-backup-policies/{policy_id}
Delete dp block backup policy
DeleteDpBlockBackupPolicy 2 params → 202400404500
PATCH
/dp-block-backup-policies/{policy_id}
Update dp block backup policy
UpdateDpBlockBackupPolicy 2 params → 200202400404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are DpBlockBackupPolicy (12 properties), DpBlockBackupPolicyCreateReq_Policy (7 properties), DpBlockBackupPolicyUpdateReq_Policy (5 properties), DpSite_Nestview (2 properties). Each schema is shown below with its type and property counts.

DpBlockBackupPoliciesResp
object
1 property
DpBlockBackupPolicyUpdateReq_Policy
object
5 properties
DpBlockBackupPolicyCreateReq
object
1 property 1 required
DpBlockBackupPolicyResp
object
1 property
DpBlockBackupPolicyCreateReq_Policy
object
7 properties 5 required
DpBlockBackupPolicyUpdateReq
object
1 property 1 required
DpSite_Nestview
object
2 properties
DpBlockBackupPolicy
object
DpBlockBackupPolicy protects a block volume by backup snapshot to remote site
12 properties
DpGateway_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-dp-block-backup-policies-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