How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
XSKY

XSKY os-search-engines API

OSSearchEngineController provides APIs for OS search engine

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 10 operations across 7 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version SDS_4.2.000.0.200302.

Requests are made against a single base URL, /v1.

10 operations 7 paths 17 schemas 1 DELETE3 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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-search-engines 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 10

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

os-search-engines 10

OSSearchEngineController provides APIs for OS search engine

GET
/os-search-engines/
List OS search engine
ListOSSearchEngines 2 params → 200500
POST
/os-search-engines/
Create OS search engine
CreateOSSearchEngine body → 202400409500
GET
/os-search-engines/{os_search_engine_id}
Get a OS search engine
GetOSSearchEngine 1 param → 200404500
DELETE
/os-search-engines/{os_search_engine_id}
delete OS search engine
DeleteOSSearchEngine 1 param → 202404409500
PATCH
/os-search-engines/{os_search_engine_id}
change OS search engine falvor or data size
ChangeOSSearchEngine 1 param body → 202400404409500
GET
/os-search-engines/{os_search_engine_id}/samples
get an object storage search engine's samples
GetOSSearchEngineSamples 4 params → 200404500
POST
/os-search-engines/{os_search_engine_id}:add-os-search-gateways
Create new OS Search gateways on OS search engine
AddOSSearchGateways 1 param body → 202400404409500
POST
/os-search-engines/{os_search_engine_id}:remove-os-search-gateways
remove OS search gateways from OS search engine
RemoveOSSearchGateways 1 param body → 202400404409500
POST
/os-search-engines/{os_search_engine_id}:start
start OS search gateways from OS search engine
StartOSSearchEngine 1 param → 202400404409500
POST
/os-search-engines/{os_search_engine_id}:stop
stop OS search gateways from OS search engine
StopOSSearchEngine 1 param → 202400404409500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are OSSearchEngine (13 properties), OSSearchEngineStat (7 properties), OSSearchEngineCreateReq_SearchEngine (5 properties), S3LoadBalancerGroup_Nestview (3 properties). Each schema is shown below with its type and property counts.

OSSearchEnginesResp
object
1 property 1 required
OSSearchEngineStat
object
OSSearchEngineStat contains info of os search engine
7 properties
OSSearchEngineRemoveGatewaysReq
object
1 property 1 required
OSSearchEngine
object
OSSearchEngine defines model of OS search engine TODO(penghui): Load balancer group
13 properties
OSSearchEngineRecord
OSSearchEngineRecord is used to combine OSSearchEngine and OSSearchEngineStat
OSSearchEngineUpdateReq_SearchEngine
object
2 properties
OSSearchEngineResp
object
1 property 1 required
OSSearchEngineSamplesResp
object
1 property 1 required
OSSearchEngineCreateReq
object
1 property 1 required
S3LoadBalancerGroup_Nestview
object
3 properties
OSSearchEngineCreateReq_SearchEngine
object
5 properties 3 required
OSSearchGatewayReq
object
2 properties 2 required
OSSearchEngineRemoveGatewaysReq_SearchEngine
object
1 property 1 required
OSSearchEngineAddGatewaysReq_SearchEngine
object
1 property 1 required
OSSearchEngineUpdateReq
object
1 property 1 required
VMFlavor_Nestview
object
2 properties
OSSearchEngineAddGatewaysReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-search-engines-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

XSKY access-paths API
AE Profile APIs.io
XSKY access-tokens API
AE Profile APIs.io
XSKY action-logs API
AE Profile APIs.io
XSKY alert-groups API
AE Profile APIs.io
XSKY alert-rules API
AE Profile APIs.io
XSKY alerts API
AE Profile APIs.io
XSKY auth API
AE Profile APIs.io
XSKY block-snapshots API
AE Profile APIs.io
XSKY block-volume-group-snapshots API
AE Profile APIs.io
XSKY block-volume-groups API
AE Profile APIs.io
XSKY block-volume-migration-jobs API
AE Profile APIs.io
XSKY block-volumes API
AE Profile APIs.io
#os-search-engines
← Back to X APIs
API Details
ID
xsky:xsky-os-search-engines-api
Base URL
https://{xms-controller}/v1
Docs
https://github.com/xsky-storage/go-sdk
Provider
XSKY
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=xsky-os-search-engines-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/xsky-os-search-engines-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of XSKY os-search-engines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.