PDF(807.5 KB) View with Adobe Reader on a variety of devices
ePub(789.4 KB) View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
Mobi (Kindle)(551.6 KB) View on Kindle device or Kindle app on multiple devices
Updated:January 19, 2021
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This document describes the four basic API (Application Program Interface) functions GET, POST, PUT, DELETE used on CMS (Cisco Meeting Server). As of CMS 2.9, the web admin GUI has an API menu available under the Configuration menu. This document reviews that new menu and also describes two different API tools: Poster and Postman and how to use them for CMS configuration.
There are no specific requirements for this document.
This document is not restricted to specific software and hardware versions.
The information in this document can be used with CMS 2.9 and later or with different API clients like Postman or Poster. These third-party tools are described in the API clients section of the document.
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, make sure that you understand the potential impact of any command.
The API for the CMS is an extremely flexible way to configure many of its features. There are far too many API features to memorize or cover here, so be sure to reference the current API Reference documentation. As of the time of this writing, the current API Reference guides are available here.
API Request and Response
API communication is a request-response relationship between clients and servers. The client makes a request of the server. After handling the request (completing an action, or refusing to do so) a response is returned.
The four requests described in this article are:
GET - Retrieves existing information
POST - Creates new information
PUT - Modifies existing information
DELETE - Deletes existing information.
These are the basic API requests used to configure CMS.
The most common response is a 200 OK. Other responses are 4xx and 5xx, which are error responses.
CMS 2.9 and Later
CMS 2.9 introduced a new API menu that makes it much easier for administrators to modify settings and fine tune settings in CMS. When using the menu, all available parameters are displayed, which makes it quick and easy to change settings and enable new features.
Configure an API Object
Once in the API menu, you can filter the API objects to what you are looking to edit/create and then click the black arrow next to the object to make those changes. This example shows how to look up callLegProfiles and create a new callLegProfile.
When you click Create New, you are presented with this screen which displays all available parameters for CallLegProfiles. When you hover over a particular parameter, you will get a popup that shows the purpose of each option.
Modify an API Object That is Already Created
When you change settings in an object, you will see the Modify button at the bottom. This is the same as a PUT from the third-party tools.
Delete an API Object from the API Menu
In order to delete an object, on the main Object List page, you can enable the ability to delete items. Click Allow delete in order to enable the option to delete, as shown in this example:
API Requests Explained (using 3rd party tools)
The four basic requests are explained through a configuration example.
Step 1. Use POST to create an object.
In this example, a CMS Space is created using this request. In order to create the Space via API, consult the API documentation. For this example I used the CMS 2.4 API guide, but you should use the latest API guides, found here
Section 6.2 has information on how to create and modify a cospace.
The first sentence says that to create a Space, you need to send a post to /coSpaces. Then, it says the ID of the Space will be in the Location header of the 200 OK. Great, you now know how to create a Space. You just send a POST to https://<WebAdminIP>/api/v1/coSpaces.
Specify the parameters for the POST.
In section 6.2 of the documentation you see a table that lists all of the parameters you can use.
For example: Create a Space with the name APITest and a URI user part of APITestURI
The content type is application/x-www-form-urlencoded and the content is name=APITest&uri=APITestURI
When you add this parameters the request is complete, as shown in the image.
The top box in Poster is where you enter the URL for the requests.
The User Auth fields are where you enter the username and password in that order. Then, if you are doing a GET or a DELETE, choose the respective buttons. For example: click GET and a popup appears with your response. For DELETE, ensure DELETE is selected and click the green button.
For POST and PUT, content needs to be added. Select the Parameters tab and add the names and values for your parameters. Then, go back to the Content to send button and choose Body from Parameters.
Send your POST and/or PUT.
In Postman, in the top-left, choose the Method you would like to use from the drop-down box and enter the request URL.
For Authorization, choose Basic-Auth and enter your username and password. Then, choose Update Request. In the Headers tab you see an Authorization Header.
If your request is a POST/PUT, navigate to the Body tab, choose x-www-form-urlencoded and enter your parameters and values. When you are finished, choose Send.
The verification method is explained in each request.
There is currently no specific troubleshooting information available for this configuration.