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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Ant Media

Ant Media Management API

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

Ant Media Management API is one of 8 APIs that Ant Media publishes on the 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.

This API exposes 50 operations across 45 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version v2.0.

Requests are made against a single base URL, https://{ant-media-server}:5443/rest/.

50 operations 45 paths 11 schemas 3 DELETE34 GET11 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2.0
Base URL
https://{ant-media-server}:5443/rest/v2/
Contact
Ant Media Info
License
Apache 2.0
Resource Areas
1

Paths & Operations 50

Across 45 paths, the API surfaces 50 operations — 3 DELETE, 34 GET, 11 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Management 50
POST
/v2/users/initial
Creates initial user
addInitialUser body → 200
PUT
/v2/users
Edit the user
editUser body → 200
POST
/v2/users
Creates a new user
addUser body → 200
POST
/v2/users/authenticate
Authenticates user
authenticateUser body → 200
GET
/v2/server-settings
Returns the server settings
getServerSettings → 200
POST
/v2/server-settings
Changes server settings
changeServerSettings body → 200
GET
/v2/applications/settings/{appname}
Returns the specified application settings
getSettings 1 param → 200
POST
/v2/applications/settings/{appname}
Changes the application settings
changeSettings 1 param body → 200
POST
/v2/users/password
Changes the given user's password
changeUserPassword body → 200
POST
/v2/ssl-settings
Changes ssl settings
configureSsl 2 params body → 200
PUT
/v2/applications/{appName}
Creates a new application with given name and supports uploading custom WAR files
createApplication_1 1 param body → 200
POST
/v2/applications/{appName}
Creates a new application with given name
createApplication 1 param → 200
DELETE
/v2/applications/{appName}
Deletes application with the given name
deleteApplication 2 params → 200
DELETE
/v2/users/logout
deleteSession → default
DELETE
/v2/users/{username}
Delete the user
deleteUser 1 param → 200
GET
/v2/applications/live-streams/{appname}
Returns live streams in the specified application
getAppLiveStreams 1 param → 200
GET
/v2/applications/{appName}/metrics-history
Gets recent per-application metric history (viewers, live streams)
getAppMetricsHistory 1 param → 200
GET
/v2/applications-info
Gets application info
getApplicationInfo → 200
GET
/v2/applications
Gets the applications in the server
getApplications → 200
GET
/v2/users/{usermail}/blocked
Returns if user is blocked
getBlockedStatus 1 param → 200
GET
/v2/cpu-status
Returns system cpu load, process cpu load and process cpu time
getCPUInfo → 200
GET
/v2/file-system-status
Gets system file status
getFileSystemInfo → 200
GET
/v2/gpu-status
Gets GPU information
getGPUInfo → 200
GET
/v2/heap-dump
Returns heap dump
getHeapDump → 200
GET
/v2/jvm-memory-status
Returns JVM memory information
getJVMMemoryInfo → 200
GET
/v2/last-licence-status
Returns the last checked license status
getLicenceStatus → 200
GET
/v2/licence-status
Returns license status
getLicenceStatus_1 1 param → 200
GET
/v2/log-file/{offsetSize}/{charSize}
Gets log file
getLogFile 3 params → 200
GET
/v2/network-status
Gets current network throughput across physical NICs
getNetworkStatus → 200
GET
/v2/server-time
Gets server time
getServerTime → 200
GET
/v2/system-status
Returns system information
getSystemInfo → 200
GET
/v2/system-memory-status
Gets system memory status
getSystemMemoryInfo → 200
GET
/v2/system-resources/history
Gets recent system resource usage history
getSystemResourcesHistory → 200
GET
/v2/system-resources
Gets system resource information
getSystemResourcesInfo → 200
GET
/v2/thread-dump
Gets thread dump in plain text
getThreadDump → 200
GET
/v2/thread-dump-json
Gets thread dump in json format
getThreadDumpJSON → 200
GET
/v2/threads
Returns processor's thread information
getThreadsInfo → 200
GET
/v2/live-clients-size
Returns total number of live streams
getTotalLiveStreamSize → 200
GET
/v2/user-list
Returns user list
getUserList → 200
GET
/v2/version
Returns the version of Ant Media Server
getVersion → 200
GET
/v2/admin-status
Returns admin status
isAdmin → 200
GET
/v2/authentication-status
Returns true if user is authenticated to call rest api operations
isAuthenticatedRest → 200
GET
/v2/enterprise-edition
Returns true if the server is enterprise edition
isEnterpriseEdition → 200
GET
/v2/first-login-status
Checks first login status
isFirstLogin → 200
GET
/v2/shutdown-proper-status
Checks whether application or applications have shutdown properly
isShutdownProperly 1 param → 200400
GET
/v2/liveness
Returns the hostname to check liveness with HTTP type healthcheck
liveness → 200
POST
/v2/applications/{appname}/reset
Resets the viewer counts and broadcasts statuses in the db
resetBroadcast 1 param → 200
GET
/v2/shutdown-properly
Set application or applications shutdown property to true
setShutdownStatus 1 param → 200
POST
/v2/system/gc
Trigger garbage collector
triggerGc → 200
POST
/v2/support/request
sendSupportRequest body → default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are AppSettings (186 properties), ServerSettings (35 properties), ApplicationContext (11 properties), User (10 properties). Each schema is shown below with its type and property counts.

AppSettings
object
186 properties
ApplicationContext
object
11 properties
AutowireCapableBeanFactory
object
BeanFactory
object
EncoderSettings
object
5 properties
Environment
object
2 properties
FormDataContentDisposition
object
8 properties
Result
object
The basic result class
4 properties
ServerSettings
object
35 properties
SupportRequest
object
5 properties
User
object
The user information
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ant-media-management-api-openapi.yml Raw ↑

Other APIs Ant Media publishes across the network.

Ant Media Server REST API
AE Profile APIs.io
Ant Media Broadcasts API
AE Profile APIs.io
Ant Media Filters API
AE Profile APIs.io
Ant Media Push Notification API
AE Profile APIs.io
Ant Media Version API
AE Profile APIs.io
Ant Media Vods API
AE Profile APIs.io
Ant Media Cluster API
AE Profile APIs.io
#Management#Administration#Server Settings#Monitoring
← Back to A APIs
API Details
ID
ant-media:ant-media-management-api
Base URL
https://{ant-media-server}:5443/rest/v2/
Docs
https://docs.antmedia.io/guides/developer-sdk-and-api/rest-api-guide/management-rest-apis/
Provider
Ant Media
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=ant-media-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ant-media-management-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Ant Media Management 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.