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 protection-domains API

ProtectionDomainController Protection Domain Management

XSKY protection-domains API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include protection-domains. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

2 operations 2 paths 8 schemas 2 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 protection-domains 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 2

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

protection-domains 2

ProtectionDomainController Protection Domain Management

GET
/protection-domains/
List protection domains
ListProtectionDomains 4 params → 200
GET
/protection-domains/{protection_domain_id}
get protection domain
GetProtectionDomain 1 param → 200400404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ProtectionDomain (7 properties), PlacementNode_Nestview_parent (7 properties), PlacementNode (7 properties), PlacementNode_Nestview (2 properties). Each schema is shown below with its type and property counts.

PlacementNode_Nestview
object
2 properties
PdRecord
PdRecord defines the response content of protection domain related API
PlacementNodeProperties
object
PlacementNodeProperties contains properties for a placement node.
1 property
ProtectionDomain
object
ProtectionDomain defines protection domain objects
7 properties
PlacementNode_Nestview_parent
object
parent of placement node
7 properties
PlacementNode
object
PlacementNode defines a placement node managing a range of hosts
7 properties
ProtectionDomainRecordResp
object
1 property 1 required
ProtectionDomainRecordsResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-protection-domains-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