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

TargetController Operations able targets

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

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

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

3 operations 2 paths 7 schemas 1 DELETE1 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 targets 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 3

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

targets 3

TargetController Operations able targets

GET
/targets/
List all targets in the cluster
ListTargets 6 params → 200400500
POST
/targets/
Create target
CreateTarget 1 param → 202400404409500
DELETE
/targets/{target_id}
delete target
DeleteTarget 2 params → 202400404409500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Target (9 properties), Host_Nestview (3 properties), AccessPath_Nestview (2 properties), TargetCreateReq_Target (2 properties). Each schema is shown below with its type and property counts.

TargetsResp
object
1 property 1 required
TargetCreateReq_Target
object
2 properties
Host_Nestview
object
3 properties 1 required
AccessPath_Nestview
object
2 properties
TargetCreateReq
object
1 property
Target
object
Target defines access path info for host
9 properties
TargetResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-targets-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