Table of Contents
Advertisement
Chapter 6: Using the Administration API
Working with the Administration API
About the Administration API
Use the Administration API to monitor, manage, and configure the server from an Adobe Flash Player or Adobe AIR
client over RTMP or RTMPE or from a web client over HTTP. The Flash Media Server Administration Console was
built using the Administration API. The API is documented in
Reference.
Here are a few important tips for working with the Administration API:
• Both Adobe Flash Media Server and Flash Media Administration Server must be running.
• This document assumes that you have not changed the default port number (1111) for the Administration Server;
if you have, use your valid port number in all examples.
• If you do not specify an optional parameter, a default value may be used depending on the method. For example, if
you do not specify a virtual host in the
the virtual host to which you connected when you logged in to Flash Media Server.
• By default, administrators are logged in to the "_defaultRoot_" adaptor. When logging in to a virtual host not on
the default adaptor, virtual-host administrators must specify the name of the adaptor. For example, when logging
in (over RTMP using NetConnection) to a virtual host on the adaptor
would enter the following information for the administrator user name parameter in the method call:
_secondAdaptor_/JLee
Set permissions for Administration API method calls over HTTP
Note: You do not need to set permissions to call methods over RTMP.
Open the fms.ini file in the RootInstall/conf folder.
1
Make sure that the
2
USERS.HTTPCOMMAND_ALLOW
3
Open the Users.xml file in the RootInstall/conf folder.
In the
element, enter method names in a comma-delimited list to allow HTTP requests to execute
4
<Allow>
Administration API calls. For example, the following code allows the
<AdminServer>
<HTTPCommands>
<Enable>${USERS.HTTPCOMMAND_ALLOW}/Enable>
<Allow>ping,changePswd</Allow>
<Deny>All</Deny>
<Order>Deny,Allow</Deny>
</HTTPCommands>
</AdminServer>
Note: There are additional XML elements in the Users.xml file that give you finer control over permissions. For more
information, see
"XML configuration files
Save the file and restart Flash Media Administration Server.
5
parameter, it is assumed that you want to perform the command on
scope
.
parameter is set to
reference" on page 123.
Last updated 11/28/2012
Adobe Flash Media Server Administration API
_secondAdaptor_
.
true
and
ping()
changePswd()
116
, the administrator
JLee
methods:
Advertisement
Table of Contents
