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 os-custom-labels API

OSCustomLabelController provides API for object storage custom label

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

Tagged areas include os-custom-labels. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 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.

2 operations 2 paths 5 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 os-custom-labels 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.

os-custom-labels 2

OSCustomLabelController provides API for object storage custom label

GET
/os-custom-labels/
List object storage custom labels
ListOSCustomLabels 4 params → 200404500
GET
/os-custom-labels/{os_custom_label_id}
Get object storage custom label
GetOSCustomLabel 1 param → 200404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are OSCustomLabel (8 properties), ObjectStorageBucket_Nestview (3 properties), ObjectStorageBucket_Nestview_lifecycle (3 properties), OSCustomLabelResp (1 property). Each schema is shown below with its type and property counts.

ObjectStorageBucket_Nestview_lifecycle
object
3 properties
OSCustomLabelsResp
object
1 property 1 required
ObjectStorageBucket_Nestview
object
3 properties
OSCustomLabel
object
OSCustomLabel the struct of object storage custom label
8 properties
OSCustomLabelResp
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-custom-labels-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