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 system-logs API

SystemLogController provides API for system logs

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

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

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

2 operations 2 paths 7 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 system-logs 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.

system-logs 2

SystemLogController provides API for system logs

GET
/system-logs/
List system logs
ListSystemLogs 4 params → 200500
GET
/system-logs/archive
download system logs
DownloadSystemLogs → 200204500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Host (28 properties), SystemLog (6 properties), HostFcPort (4 properties), Disk_Nestview (3 properties). Each schema is shown below with its type and property counts.

HostFcPort
object
HostFcPort defines fc port on the host
4 properties
Host
object
Host defines the installed hosts @grpc-models-proto
28 properties 1 required
Host_Nestview
object
3 properties 1 required
SystemLog
object
SystemLog defines the system log
6 properties
SystemLogsResp
object
1 property 1 required
Disk_Nestview
object
3 properties
ProtectionDomain_Nestview
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-system-logs-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