• |
Auth Token - You can authenticate with an Auth Token set in the Foglight Users & Security dashboard. This eliminates the need to pass your user credentials to Foglight. |
The table below lists the registry variables used by the Foglight REST API. These variables are created by the Forge-RestAPI cartridge. These registry variables specify the default behavior of the REST API and can be modified by the parameters listed in Query Parameters.
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 2: 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. Términos de uso Privacidad Cookie Preference Center