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

SnmpController Operations able snmp

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

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

This API exposes 3 operations across 2 paths, and defines 9 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 9 schemas 2 GET1 PATCH

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 snmp 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 — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

snmp 3

SnmpController Operations able snmp

GET
/snmp/
get snmp info
GetSnmp → 200500
PATCH
/snmp/
set snmp
SetSnmp 1 param → 200500
GET
/snmp/mib
download snmp mib file
DownloadMib → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SnmpGateway (19 properties), SnmpGatewayReq (14 properties), TrapReceiver (6 properties), SnmpResp_Snmp (3 properties). Each schema is shown below with its type and property counts.

SnmpSetReq_Snmp
object
3 properties
Host_Nestview
object
3 properties 1 required
SnmpGatewayReq
object
14 properties
SnmpTrapReceiverReq
object
2 properties
SnmpResp
object
1 property 1 required
SnmpGateway
object
SnmpGateway defines the snmp gateway
19 properties
SnmpSetReq
object
1 property
SnmpResp_Snmp
object
3 properties 3 required
TrapReceiver
object
TrapReceiver defines the snmp trap receiver
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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