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 network-diagnoses API

NetworkDiagnosisController provides API for network diagnosis

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

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

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

5 operations 3 paths 5 schemas 1 DELETE2 GET2 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 network-diagnoses 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 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

network-diagnoses 5

NetworkDiagnosisController provides API for network diagnosis

GET
/network-diagnoses/
List network diagnoses
ListNetworkDiagnoses 2 params → 200500
POST
/network-diagnoses/
Create network diagnosis
CreateNetworkDiagnosis 1 param → 200201400404409500
GET
/network-diagnoses/{network_diagnosis_id}
Get network diagnosis
GetNetworkDiagnosis 1 param → 200404500
DELETE
/network-diagnoses/{network_diagnosis_id}
delete network diagnosis
DeleteNetworkDiagnosis 1 param → 204404409500
POST
/network-diagnoses/{network_diagnosis_id}:stop
stop network diagnosis
StopNetworkDiagnosis 1 param → 202404409500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are NetworkDiagnosis (13 properties), NetworkDiagnosisCreateReq_Diagnosis (3 properties), NetworkDiagnosisResp (1 property), NetworkDiagnosisCreateReq (1 property). Each schema is shown below with its type and property counts.

NetworkDiagnosisCreateReq_Diagnosis
object
3 properties 3 required
NetworkDiagnosis
object
NetworkDiagnosis defines model of network diagnosis
13 properties
NetworkDiagnosesResp
object
1 property 1 required
NetworkDiagnosisCreateReq
object
1 property 1 required
NetworkDiagnosisResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-network-diagnoses-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