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

DpBlockSnapshotJobController API /dp-block-snapshot-jobs/

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

This API exposes 1 operation across 1 path, and defines 5 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.

1 operations 1 paths 5 schemas 1 GET

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-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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

dp-block-snapshot-jobs 1

DpBlockSnapshotJobController API /dp-block-snapshot-jobs/

GET
/dp-block-snapshot-jobs/
List dp block snapshot jobs
ListDpBlockSnapshotJobs 7 params → 200500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are DpBlockSnapshotJob (12 properties), Volume_Nestview (3 properties), DpBlockSnapshotPolicy_Nestview (2 properties), Snapshot_Nestview (2 properties). Each schema is shown below with its type and property counts.

DpBlockSnapshotJob
object
DpBlockSnapshotJob is one execution of a dp block snapshot plan
12 properties
Snapshot_Nestview
object
2 properties
DpBlockSnapshotPolicy_Nestview
object
2 properties
DpBlockSnapshotJobsResp
object
1 property 1 required
Volume_Nestview
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-dp-block-snapshot-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