Foglight 5.9.1 - REST API Reference Guide

Getting Started

The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data.

The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems.

This section introduces you to the Foglight REST APIs. For more information, see the following topics:

Glossary

Table 1 explains the token that protects the access to REST APIs and is used as the request header for REST APIs. Auth-Token has been replaced with Access-Token in the Foglight Management Server 5.9.1, but Auth-Token is still supported. Quest recommends that you change to use Access-Token as the request header for REST APIs, as Auth-Token will be deprecated in future product release.

NOTE: Retrieving the access token through authToken is only available in the Foglight release 5.7.5.7 or later.

Prerequisites

REST APIs are protected by authentications, which means you need retrieve an access token before using REST APIs. The authentications protecting REST APIs include the following two approaches:

Use the Security — Login API to retrieve an access token through user credentials or an authToken, then include this access token in an HTTP request header to operate with REST APIs.

NOTE: The minimum version required for operating REST APIs is Foglight Management Server 5.7.0. Retrieving an access token through authToken is only available in the Foglight release 5.7.5.7 or later.

For more information about how to use the Security — Login API with third party tools, visit the Foglight REST APIs Introduction - Java and Python Sample Code.

Overview

Table 2 lists the registry variables available after installing the Forge-RestAPI cartridge:

Most of registry variables listed in Table 3: URL parameters can be overwritten by the following URL parameters per request.