# Ant Media Cluster API

**Canonical:** https://apis.io/apis/ant-media/ant-media-cluster-api/  
**Provider:** Ant Media — https://apis.io/providers/ant-media/  
**Base URL:** https://{ant-media-server}:5443/rest/v2/  
**Documentation:** https://docs.antmedia.io/guides/developer-sdk-and-api/rest-api-guide/management-rest-apis/

Ant Media Cluster API is one of 8 APIs that [Ant Media](https://apis.io/providers/ant-media/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Cluster and Scaling. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ant-media/refs/heads/main/openapi/ant-media-cluster-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/ant-media/refs/heads/main/overlays/ant-media-cluster-overlay.yaml
- **Documentation** — https://docs.antmedia.io/category/clustering-and-scaling/

## Other Ant Media APIs (7)

- [Ant Media Server REST API](https://apis.io/apis/ant-media/ant-media-server-rest-api/)
- [Ant Media Broadcasts API](https://apis.io/apis/ant-media/ant-media-broadcasts-api/)
- [Ant Media Filters API](https://apis.io/apis/ant-media/ant-media-filters-api/)
- [Ant Media Push Notification API](https://apis.io/apis/ant-media/ant-media-push-notification-api/)
- [Ant Media Version API](https://apis.io/apis/ant-media/ant-media-version-api/)
- [Ant Media Vods API](https://apis.io/apis/ant-media/ant-media-vods-api/)
- [Ant Media Management API](https://apis.io/apis/ant-media/ant-media-management-api/)

## Tags

Cluster, Scaling

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ant-media/ant-media-cluster-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ant-media/.