Contents

Introduction

Prerequisites

Requirements

Components Used

AccessOnboard API Documentation

Test APIs from the Documentation Tool

Related Information

Introduction

This document describes how to validate and configure REST API calls to vManage through the use of on-board documentation.

Prerequisites

Requirements

There are no specific requirements for this document.

Components Used

This document is not restricted to specific software versions or vManage deployment types.

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, ensure that you understand the potential impact of any command.

Access Onboard API Documentation

vManage onboard API documentation is at the URL https://<vmanage_ip>:<port:>/apidocs.  This documentation displays APIs available on the current software version.

This requires log in with valid vManage credentials.  While multiple privilege levels can view documentation, only a netadmin user is able to execute all of them.

Note: The API documentation page is available to tenants in a multitenant environment, however, certain commands are restricted to the provider only.

vManage then displays a list of categories of available APIs.  Click the desired category, followed by the API call itself, which displays these fields:

Description/Implementation Notes

Description of the operation performed.

Parameters

Required parameters to be specified for the API call.

Request Body (POST/PUT/DELETE)

Format of the request body.

Responses

Possible responses which vManage sends to the API.  This includes HTTP status code, reason, and the possible response body.

Extensions

Valid extensions for the call.

Test APIs from the Documentation Tool

Available APIs can be tested via the Try It Out option.

Note: Be aware that this is not a simulation. The call is actually executed on the local vManage.  Plan for any associated impact accordingly.

1. Click the Try It Out button.

2. Input all required parameters.

3. Click Execute.

This command performs the API task, and returns the response received from vManage, which includes these fields:

Request URL

The full URL used, which includes the vManage address and any parameters entered.  This can be used by applicable scripts or utilities which have successfully authenticated sessions.

Response Body

The full response data received.

Response Code

The HTTP status code received.

Response Headers

Headers used.

Related Information

Cisco Developer vManage API Documentation