Ant Media

Ant Media Cluster API

The cluster surface of the Ant Media Server management panel REST API — 9 operations for listing cluster nodes with offset/size paging, counting them, annotating a node with a note, and removing a node. Exposed at both /v2/cluster/... and a legacy /cluster/... prefix.

Documentation GitHub OpenAPI

Operations 9

DELETE /v2/cluster/node/{id} #

GET /v2/cluster/node-count #

GET /v2/cluster/nodes/{offset}/{size} #

PUT /v2/cluster/node/{id}/note #

GET /cluster/deleteNode/{id} #

GET /cluster/node-count #

GET /cluster/nodes/{offset}/{size} #

PUT /cluster/node/{id}/note #

GET /v2/cluster-mode-status Returns the server mode #

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/ant-media-cluster-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Ant Media Server Management Panel REST API Cluster API
  description: Ant Media Server Management Panel REST API
  contact:
    name: Ant Media Info
    url: https://antmedia.io
    email: contact@antmedia.io
  license:
    name: Apache 2.0
    url: http://www.apache.org
  version: v2.0
servers:
- url: https://{ant-media-server}:5443/rest/
  description: Ant Media Server management panel REST base. Ant Media Server is self-hosted, so the host is the customer's own server; port 5443 and the /rest/ prefix are the values published in the Management Panel REST API guide.
  variables:
    ant-media-server:
      default: your-ant-media-server
      description: Hostname or IP of your Ant Media Server instance
tags:
- name: Cluster
paths:
  /v2/cluster/node/{id}:
    delete:
      operationId: deleteNode
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
      tags:
      - Cluster
  /v2/cluster/node-count:
    get:
      operationId: getNodeCount
      responses:
        default:
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SimpleStat'
      tags:
      - Cluster
  /v2/cluster/nodes/{offset}/{size}:
    get:
      operationId: getNodeList
      parameters:
      - name: offset
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: size
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterNode'
      tags:
      - Cluster
  /v2/cluster/node/{id}/note:
    put:
      operationId: updateNodeNote
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: note
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
      tags:
      - Cluster
  /cluster/deleteNode/{id}:
    get:
      operationId: deleteNode_1
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
      tags:
      - Cluster
  /cluster/node-count:
    get:
      operationId: getNodeCount_1
      responses:
        default:
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SimpleStat'
      tags:
      - Cluster
  /cluster/nodes/{offset}/{size}:
    get:
      operationId: getNodeList_1
      parameters:
      - name: offset
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: size
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterNode'
      tags:
      - Cluster
  /cluster/node/{id}/note:
    put:
      operationId: updateNodeNote_1
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: note
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
      tags:
      - Cluster
  /v2/cluster-mode-status:
    get:
      summary: Returns the server mode
      operationId: isInClusterMode
      responses:
        '200':
          description: Server mode returned
      tags:
      - Cluster
components:
  schemas:
    ClusterNode:
      type: object
      properties:
        id:
          type: string
        ip:
          type: string
        lastUpdateTime:
          type: integer
          format: int64
        memory:
          type: string
        cpu:
          type: string
        dbQueryAveargeTimeMs:
          type: integer
          format: int32
        note:
          type: string
        status:
          type: string
    Result:
      type: object
      properties:
        success:
          type: boolean
          description: The result of the operation
        message:
          type: string
          description: The message of the operation result
        dataId:
          type: string
          description: The id of the record if operation is about adding a record
        errorId:
          type: integer
          description: The id of error of the operation result
          format: int32
      description: The basic result class
    SimpleStat:
      type: object
      properties:
        number:
          type: integer
          description: the stat value
          format: int64
      description: Simple generic statistics class to return single values
externalDocs:
  url: https://docs.antmedia.io/guides/developer-sdk-and-api/rest-api-guide/management-rest-apis/
  description: Management Panel REST API Services