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 fs-active-directories API

FSActiveDirectoryController File Storage Active Directory Management

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

Tagged areas include fs-active-directories. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

6 operations 3 paths 7 schemas 1 DELETE2 GET1 PATCH2 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 fs-active-directories 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

fs-active-directories 6

FSActiveDirectoryController File Storage Active Directory Management

GET
/fs-active-directories/
List file storage active directories
ListFSActiveDirectories 2 params → 200500
POST
/fs-active-directories/
create file storage active directory
CreateFSActiveDirectory 1 param → 202400409500
GET
/fs-active-directories/{fs_active_directory_id}
Get a file storage active directory
GetFSActiveDirectory 1 param → 200404500
DELETE
/fs-active-directories/{fs_active_directory_id}
Delete file storage active directory
DeleteFSActiveDirectory 1 param → 202404409500
PATCH
/fs-active-directories/{fs_active_directory_id}
Update a file storage active directory
UpdateFSActiveDirectory 2 params → 200400404500
POST
/fs-active-directories/{fs_active_directory_id}:verify
Verify a fs active directory or user/group info
VerifyFSActiveDirectory 1 param → 202404409500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are FSActiveDirectory (12 properties), FSActiveDirectoryCreateReq_Info (6 properties), FSActiveDirectoryUpdateReq_Info (6 properties), FSActiveDirectoryUpdateReq (1 property). Each schema is shown below with its type and property counts.

FSActiveDirectoryUpdateReq_Info
object
6 properties
FSActiveDirectory
object
FSActiveDirectory defines file storage active directory
12 properties
FSActiveDirectoryCreateReq
object
1 property 1 required
FSActiveDirectoriesResp
object
1 property 1 required
FSActiveDirectoryResp
object
1 property 1 required
FSActiveDirectoryUpdateReq
object
1 property 1 required
FSActiveDirectoryCreateReq_Info
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-fs-active-directories-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