# Ant Media Management API

**Canonical:** https://apis.io/apis/ant-media/ant-media-management-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 Management 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 Management, Administration, Server Settings, and Monitoring. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

The Ant Media Server Management Panel REST API — 50 operations for non-application-specific administration: creating and deleting applications, managing operator accounts, reading and writing server and application settings, SSL configuration, licence status, and the full system-health surface (CPU, GPU, JVM memory, file system, network throughput, thread and heap dumps, liveness). Harvested verbatim from the specification Ant Media publishes at https://antmedia.io/rest/3.1.0-management/swagger.json.

## Operations (50)

| Method | Path | Summary |
|---|---|---|
| POST | `/v2/users/initial` | Creates initial user |
| PUT | `/v2/users` | Edit the user |
| POST | `/v2/users` | Creates a new user |
| POST | `/v2/users/authenticate` | Authenticates user |
| GET | `/v2/server-settings` | Returns the server settings |
| POST | `/v2/server-settings` | Changes server settings |
| GET | `/v2/applications/settings/{appname}` | Returns the specified application settings |
| POST | `/v2/applications/settings/{appname}` | Changes the application settings |
| POST | `/v2/users/password` | Changes the given user's password |
| POST | `/v2/ssl-settings` | Changes ssl settings |
| PUT | `/v2/applications/{appName}` | Creates a new application with given name and supports uploading custom WAR files |
| POST | `/v2/applications/{appName}` | Creates a new application with given name |
| DELETE | `/v2/applications/{appName}` | Deletes application with the given name |
| DELETE | `/v2/users/logout` | — |
| DELETE | `/v2/users/{username}` | Delete the user |
| GET | `/v2/applications/live-streams/{appname}` | Returns live streams in the specified application |
| GET | `/v2/applications/{appName}/metrics-history` | Gets recent per-application metric history (viewers, live streams) |
| GET | `/v2/applications-info` | Gets application info |
| GET | `/v2/applications` | Gets the applications in the server |
| GET | `/v2/users/{usermail}/blocked` | Returns if user is blocked |
| GET | `/v2/cpu-status` | Returns system cpu load, process cpu load and process cpu time |
| GET | `/v2/file-system-status` | Gets system file status |
| GET | `/v2/gpu-status` | Gets GPU information |
| GET | `/v2/heap-dump` | Returns heap dump |
| GET | `/v2/jvm-memory-status` | Returns JVM memory information |
| GET | `/v2/last-licence-status` | Returns the last checked license status |
| GET | `/v2/licence-status` | Returns license status |
| GET | `/v2/log-file/{offsetSize}/{charSize}` | Gets log file |
| GET | `/v2/network-status` | Gets current network throughput across physical NICs |
| GET | `/v2/server-time` | Gets server time |
| GET | `/v2/system-status` | Returns system information |
| GET | `/v2/system-memory-status` | Gets system memory status |
| GET | `/v2/system-resources/history` | Gets recent system resource usage history |
| GET | `/v2/system-resources` | Gets system resource information |
| GET | `/v2/thread-dump` | Gets thread dump in plain text |
| GET | `/v2/thread-dump-json` | Gets thread dump in json format |
| GET | `/v2/threads` | Returns processor's thread information |
| GET | `/v2/live-clients-size` | Returns total number of live streams |
| GET | `/v2/user-list` | Returns user list |
| GET | `/v2/version` | Returns the version of Ant Media Server |
| GET | `/v2/admin-status` | Returns admin status |
| GET | `/v2/authentication-status` | Returns true if user is authenticated to call rest api operations |
| GET | `/v2/enterprise-edition` | Returns true if the server is enterprise edition |
| GET | `/v2/first-login-status` | Checks first login status |
| GET | `/v2/shutdown-proper-status` | Checks whether application or applications have shutdown properly |
| GET | `/v2/liveness` | Returns the hostname to check liveness with HTTP type healthcheck |
| POST | `/v2/applications/{appname}/reset` | Resets the viewer counts and broadcasts statuses in the db |
| GET | `/v2/shutdown-properly` | Set application or applications shutdown property to true |
| POST | `/v2/system/gc` | Trigger garbage collector |
| POST | `/v2/support/request` | — |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ant-media/refs/heads/main/openapi/ant-media-management-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/ant-media/refs/heads/main/overlays/ant-media-management-overlay.yaml
- **Documentation** — https://docs.antmedia.io/guides/developer-sdk-and-api/rest-api-guide/management-rest-apis/
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/ant-media/refs/heads/main/authentication/ant-media-authentication.yml

## 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 Cluster API](https://apis.io/apis/ant-media/ant-media-cluster-api/)

## Tags

Management, Administration, Server Settings, Monitoring

---

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