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 placement-nodes API

PlacementNodeController provides API for placement node

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

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

This API exposes 5 operations across 3 paths, and defines 10 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 10 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 placement-nodes 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, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

placement-nodes 5

PlacementNodeController provides API for placement node

POST
/placement-nodes/
Create placement node
CreatePlacementNode 1 param → 201400500
GET
/placement-nodes/{placement_node_id}
Get placement node
GetPlacementNode 1 param → 200404500
DELETE
/placement-nodes/{placement_node_id}
delete placement node
DeletePlacementNode 1 param → 204404409500
PATCH
/placement-nodes/{placement_node_id}
update placement node
UpdatePlacementNode 2 params → 200400404500
GET
/placement-nodes/{placement_node_id}/topology
Get subtree topology of placement node
GetPlacementNodeTopology 5 params → 200404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PlacementNode (7 properties), PlacementNodeCreateReq_PlacementNode (4 properties), PlacementNodeUpdateReq_PlacementNode (2 properties), PlacementNodeTopologyResp (1 property). Each schema is shown below with its type and property counts.

PlacementNodeCreateReq_PlacementNode
object
4 properties 3 required
PlacementNodeUpdateReq
object
1 property
PlacementNodeResp
object
1 property 1 required
PlacementNodeProperties
object
PlacementNodeProperties contains properties for a placement node.
1 property
PlacementNodeRecord
PlacementNodeTopology
PlacementNodeTopology defines the response content of placement node topology
PlacementNodeTopologyResp
object
1 property 1 required
PlacementNodeCreateReq
object
1 property
PlacementNode
object
PlacementNode defines a placement node managing a range of hosts
7 properties
PlacementNodeUpdateReq_PlacementNode
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-placement-nodes-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