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-remote-policies API

OSRemotePolicyController API /os-remote-policies

XSKY os-remote-policies 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-remote-policies. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 3 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 3 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-remote-policies 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-remote-policies 2

OSRemotePolicyController API /os-remote-policies

GET
/os-remote-policies/
List os remote policies
ListOSRemotePolicies 4 params → 200
GET
/os-remote-policies/{policy_uuid}
Get a os remote policy
GetOSRemotePolicy 1 param → 200404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are OSRemotePolicy (7 properties), OSRemotePoliciesResp (1 property), OSRemotePolicyResp (1 property). Each schema is shown below with its type and property counts.

OSRemotePolicy
object
OSRemotePolicy defines model of cached remote os policy.
7 properties
OSRemotePolicyResp
object
1 property
OSRemotePoliciesResp
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-remote-policies-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