XSKY alerts API

AlertController Operations about alert

Operations 7

GET /alerts/ #
DELETE /alerts/ #
PATCH /alerts/ #
GET /alerts/stats #
PUT /alerts/{alert_id} #
DELETE /alerts/{alert_id} #
POST /alerts/{alert_id}:resolve #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/xsky-alerts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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

OpenAPI Specification

xsky-alerts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: XMS is the controller of distributed storage system
  version: SDS_4.2.000.0.200302
  title: XMS access-paths Alerts API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: alerts
  description: 'AlertController Operations about alert

    '
paths:
  /alerts/:
    get:
      tags:
      - alerts
      description: List all alerts
      operationId: ListAlerts
      parameters:
      - name: limit
        in: query
        description: paging param
        required: false
        x-exportParamName: Limit
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: paging param
        required: false
        x-exportParamName: Offset
        schema:
          type: integer
          format: int64
      - name: resource_type
        in: query
        description: resource type of alert
        required: false
        x-exportParamName: ResourceType
        schema:
          type: string
      - name: resource_id
        in: query
        description: resource id of alert
        required: false
        x-exportParamName: ResourceId
        schema:
          type: integer
          format: int64
      - name: alert_type
        in: query
        description: type of alert
        required: false
        x-exportParamName: AlertType
        schema:
          type: string
      - name: acked
        in: query
        description: acked of alert
        required: false
        x-exportParamName: Acked
        schema:
          type: boolean
      - name: resolved
        in: query
        description: resolved or not of alert
        required: false
        x-exportParamName: Resolved
        schema:
          type: boolean
      - name: resolve_type
        in: query
        description: resolve type of alert
        required: false
        x-exportParamName: ResolveType
        schema:
          type: string
      - name: level
        in: query
        description: level of alert
        required: false
        x-exportParamName: Level
        schema:
          type: string
      - name: duration_begin
        in: query
        description: duration begin timestamp
        required: false
        x-exportParamName: DurationBegin
        schema:
          type: string
      - name: duration_end
        in: query
        description: duration end timestamp
        required: false
        x-exportParamName: DurationEnd
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsResp'
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
    delete:
      tags:
      - alerts
      description: delete alerts
      operationId: DeleteAlerts
      parameters:
      - name: before
        in: query
        description: create time of last alert
        required: false
        x-exportParamName: Before
        schema:
          type: string
      responses:
        204:
          description: No Content
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
    patch:
      tags:
      - alerts
      description: set the ack status of alerts
      operationId: DoAlerts
      responses:
        204:
          description: No Content
        400:
          description: BadRequest
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertsActionReq'
        description: the alerts action info
        required: true
  /alerts/stats:
    get:
      tags:
      - alerts
      description: count all alert
      operationId: CountAlerts
      parameters:
      - name: acked
        in: query
        description: acked of alert
        required: false
        x-exportParamName: Acked
        schema:
          type: boolean
      - name: resolved
        in: query
        description: resolved or not of alert
        required: false
        x-exportParamName: Resolved
        schema:
          type: boolean
      - name: resource_type
        in: query
        description: resource type of alert
        required: false
        x-exportParamName: ResourceType
        schema:
          type: string
      - name: resource_id
        in: query
        description: resource id of alert
        required: false
        x-exportParamName: ResourceId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertStatsResp'
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
  /alerts/{alert_id}:
    put:
      tags:
      - alerts
      description: set the ack status of alert
      operationId: DoAlert
      parameters:
      - name: alert_id
        in: path
        description: the id of alert
        required: true
        x-exportParamName: AlertId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertActionReq'
        description: the alert action info
        required: true
    delete:
      tags:
      - alerts
      description: Delete alert
      operationId: DeleteAlert
      parameters:
      - name: alert_id
        in: path
        description: alert id
        required: true
        x-exportParamName: AlertId
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: No Content
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
  /alerts/{alert_id}:resolve:
    post:
      tags:
      - alerts
      description: set the resolved status of alert
      operationId: ResolveAlert
      parameters:
      - name: alert_id
        in: path
        description: the id of alert
        required: true
        x-exportParamName: AlertId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
components:
  schemas:
    Alert:
      type: object
      properties:
        ack_time:
          type: string
          format: date-time
        acked:
          type: boolean
        alarm_id:
          type: string
        alert_value:
          type: string
        create:
          type: string
          format: date-time
        data:
          type: object
          properties: {}
        extra_data:
          type: string
        group:
          type: string
        host:
          $ref: '#/components/schemas/Host_Nestview'
        id:
          type: integer
          format: int64
        level:
          type: string
        related_resources:
          type: array
          items:
            type: object
            properties: {}
        resolve_time:
          type: string
          format: date-time
        resolve_type:
          type: string
        resolved:
          type: boolean
        resource_id:
          type: integer
          format: int64
        resource_name:
          type: string
        resource_type:
          type: string
        status:
          type: string
        trigger_mode:
          type: string
        trigger_period:
          type: integer
          format: int64
        trigger_value:
          type: string
        type:
          type: string
      title: Alert
      description: Alert is a generic representation of an alert in the Prometheus eco-system.
      example:
        ack_time: '2000-01-23T04:56:07.000+00:00'
        data: '{}'
        resolve_type: resolve_type
        level: level
        resolve_time: '2000-01-23T04:56:07.000+00:00'
        resource_type: resource_type
        trigger_mode: trigger_mode
        trigger_value: trigger_value
        alert_value: alert_value
        type: type
        acked: true
        extra_data: extra_data
        related_resources:
        - '{}'
        - '{}'
        trigger_period: 5
        host:
          name: name
          admin_ip: admin_ip
          id: 0
        create: '2000-01-23T04:56:07.000+00:00'
        resource_id: 1
        alarm_id: alarm_id
        id: 6
        resource_name: resource_name
        group: group
        resolved: true
        status: status
    AlertStatsResp:
      type: object
      required:
      - alert_stats
      properties:
        alert_stats:
          description: alert stats
          $ref: '#/components/schemas/AlertStats'
      title: AlertStatsResp
      example:
        alert_stats:
          critical_num: 0
          info_num: 1
          error_num: 6
          warning_num: 5
    AlertsActionReq:
      type: object
      required:
      - alerts
      properties:
        alerts:
          $ref: '#/components/schemas/AlertsActionReq_Alerts'
      title: AlertsActionReq
      example:
        alerts:
          action: action
    AlertRecord:
      title: AlertRecord
      allOf:
      - $ref: '#/components/schemas/Alert'
      - properties:
          error_records:
            type: array
            items:
              $ref: '#/components/schemas/ErrorRecord'
      description: AlertRecord defines the response errors of alert
    Alert_Nestview:
      type: object
      properties:
        alarm_id:
          type: string
        id:
          type: integer
          format: int64
      title: Alert_Nestview
    ActionLog_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
      title: ActionLog_Nestview
    AlertsActionReq_Alerts:
      type: object
      required:
      - action
      properties:
        action:
          type: string
      title: AlertsActionReq_Alerts
      example:
        action: action
    AlertActionReq_Alert:
      type: object
      required:
      - action
      properties:
        action:
          type: string
      title: AlertActionReq_Alert
      example:
        action: action
    AlertResp:
      type: object
      required:
      - alert
      properties:
        alert:
          description: alert
          $ref: '#/components/schemas/Alert'
      title: AlertResp
      example:
        alert:
          ack_time: '2000-01-23T04:56:07.000+00:00'
          data: '{}'
          resolve_type: resolve_type
          level: level
          resolve_time: '2000-01-23T04:56:07.000+00:00'
          resource_type: resource_type
          trigger_mode: trigger_mode
          trigger_value: trigger_value
          alert_value: alert_value
          type: type
          acked: true
          extra_data: extra_data
          related_resources:
          - '{}'
          - '{}'
          trigger_period: 5
          host:
            name: name
            admin_ip: admin_ip
            id: 0
          create: '2000-01-23T04:56:07.000+00:00'
          resource_id: 1
          alarm_id: alarm_id
          id: 6
          resource_name: resource_name
          group: group
          resolved: true
          status: status
    AlertActionReq:
      type: object
      required:
      - alert
      properties:
        alert:
          $ref: '#/components/schemas/AlertActionReq_Alert'
      title: AlertActionReq
      example:
        alert:
          action: action
    Host_Nestview:
      type: object
      required:
      - admin_ip
      properties:
        admin_ip:
          type: string
        id:
          type: integer
          format: int64
        name:
          type: string
      title: Host_Nestview
      example:
        name: name
        admin_ip: admin_ip
        id: 0
    ErrorRecord:
      type: object
      properties:
        action_log:
          $ref: '#/components/schemas/ActionLog_Nestview'
        alert:
          $ref: '#/components/schemas/Alert_Nestview'
        code:
          type: string
        create:
          type: string
          format: date-time
        details:
          type: string
        extra_data:
          type: object
          properties: {}
        host:
          $ref: '#/components/schemas/Host_Nestview'
        id:
          type: integer
          format: int64
        message:
          type: string
      title: ErrorRecord
      description: ErrorRecord defines the error record attributes.
    AlertsResp:
      type: object
      required:
      - alerts
      properties:
        alerts:
          type: array
          description: alerts
          items:
            $ref: '#/components/schemas/AlertRecord'
      title: AlertsResp
      example:
        alerts:
        - ''
        - ''
    AlertStats:
      type: object
      properties:
        critical_num:
          type: integer
          format: int64
        error_num:
          type: integer
          format: int64
        info_num:
          type: integer
          format: int64
        warning_num:
          type: integer
          format: int64
      title: AlertStats
      example:
        critical_num: 0
        info_num: 1
        error_num: 6
        warning_num: 5
  securitySchemes:
    tokenInHeader:
      description: auth by token
      type: apiKey
      name: Xms-Auth-Token
      in: header
    tokenInQuery:
      description: auth by token
      type: apiKey
      name: token
      in: query