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.
• |
• |
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.
Auth-Token (available in Foglight 5.7.5.7 and 5.7.5.8 releases only) |
|
Access-Token (replaces Auth-Token starting with 5.9.1 release) |
• |
User credentials: User account and user password |
• |
Access-Token: Token-based authentication |
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.
Table 2 lists the registry variables available after installing the Forge-RestAPI cartridge:
Specifies whether the audit feature is enabled in the REST API. Enable is set by default. The audit logs can be found in the Audit dashboard. | ||||
If the resource name is specified using this variable, audit logs of specified resources cannot be found in the Audit dashboard and the audit feature is disabled.
| ||||
Specifies the REST API that is disabled by default. “Run Script” is set by default, which means Script — Run Script will be disabled after the installation. | ||||
Specifies whether the response to a request can be exposed to the page. If the returned value is: | ||||
Specifies the observation duration of the agents property in the RestAPIInfo type. The default value is 300, which is identical to 5 minutes. | ||||
Most of registry variables listed in Table 3: URL parameters can be overwritten by the following URL parameters per request.
Specifies the time duration, including startTimeMS and endTime. If startTimeMS is not set, the endTime value is used as the current time, and the startTime value is calculated as endTime minus the specified duration. | |
Specifies the startTime. The endTime is the sum of startTime and durationMS. | |
Specifies whether to retrieve the metric current value of a Topology object in a response. | |
Specifies whether to retrieve the observation current value of a Topology object in a response. | |
Excludes the properties in a Topology object. Take http://<server>:<port>/api/v1/type/Host/instances?excludePropertyPatterns=.*Alarm.*,.*State.* as an example, this URL address excludes the properties which name contains "Alarm" and "State". | |
NOTE: If excludePropertyPatterns and includePropertyPatterns are set to the same value, the value set in excludePropertyPatterns is ignored. | |
Specifies whether to show the property of the Topology type in an instance. |
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center