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

XSKY Alert Rules API

AlertRuleController Operations about alert rule

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

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

This API exposes 10 operations across 4 paths, and defines 12 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 4 paths 12 schemas 2 DELETE4 GET1 PATCH2 POST1 PUT

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 Alert Rules 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 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Alert Rules 10

AlertRuleController Operations about alert rule

GET
/alert-rules/
List alert rules
ListAlertRules 8 params → 200400500
POST
/alert-rules/
Create alert rule
CreateAlertRule body → 200400409500
PUT
/alert-rules/
Create alert rule
putAlertRules body → 200400409500
GET
/alert-rules/schema
Get alert rule schema
GetAlertRuleSchema → 200
GET
/alert-rules/{rule_id}
Get alert rule
GetAlertRule 1 param → 200404500
DELETE
/alert-rules/{rule_id}
Delete alert rule
DeleteAlertRule 1 param → 204400404500
PATCH
/alert-rules/{rule_id}
Update alert rule
UpdateAlertRule 1 param body → 200400404409500
GET
/alert-rules/{rule_id}/blacklist
List alert rule resource blacklist
ListAlertRuleResourceBlacklist 4 params → 200400500
POST
/alert-rules/{rule_id}/blacklist
Create alert rule resource blacklist
CreateAlertRuleResourceBlacklist 1 param body → 200400404409500
DELETE
/alert-rules/{rule_id}/blacklist
Delete alert rule resource blacklist
DeleteAlertRuleResourceBlacklist 1 param body → 204400404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AlertRule (13 properties), AlertRuleCreateReq_Rule (7 properties), AlertRuleUpdateReq_Rule (3 properties), AlertRuleSchemaResp (2 properties). Each schema is shown below with its type and property counts.

AlertRuleSchema
object
AlertRuleSchema defines alert rule schema
2 properties
AlertRuleResourceBlacklistResp
object
AlertRuleResp
object
1 property 1 required
AlertRuleCreateReq_Rule
object
7 properties
UpdateAlertRuleResourceBlacklistReq
object
1 property 1 required
AlertRuleSchemaResp
object
2 properties 2 required
AlertRuleUpdateReq_Rule
object
3 properties
AlertRulesResp
object
1 property 1 required
AlertRuleCreateReq
object
1 property 1 required
AlertRule
object
AlertRule defines the alert rule
13 properties
UpdateAlertRuleResourceBlacklistReq_AlertRuleResourceBlacklist
object
1 property
AlertRuleUpdateReq
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-alert-rules-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 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
XSKY Chunks API
Where this information came from

This is an independent, third-party profile of XSKY Alert Rules 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.