Chat now with support
Chat with Support

Foglight Evolve 7.3.0 - REST API Reference Guide

REST APIs

This provides you with essential information about available Foglight REST APIs. For more information, see the following topics:

App

The App related API includes the following:

API Name: Get App information
Description: Get the application information.
API path: /api/v1/
Sample usage: http://<server>:<port>/api/v1/

Security

The Security related APIs include the following:

Description: Obtain an access token through user credentials (namely username and pwd in the Parameter: table) or a digital token (namely authToken in the Parameter: table).
NOTE: Retrieving an access token through the authToken parameter is only available in the Foglight Management Server 5.7.5.7 or later.
API path: /api/v1/security/login
Sample usage: http://<server>:<port>/api/v1/security/login

Accept

String

Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

Description: Expire an access token.
API path: /api/v1/security/logout
Sample usage: http://<server>:<port>/api/v1/security/logout
API Name: Set Auth Token for a given user
Description: Set the Auth Token, which is also referred to as digital token, for a specified user account. The current user who is logging in to REST service must have the Administrator permission to use this API.
API path: /api/v1/security/setAuthToken/username
Sample usage: http://<server>:<port>/api/v1/security/setAuthToken/abcuser

Accept

String

Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

API Name: Delete Auth Token for a given user
Description: Delete the Auth Token, which is also referred to as digital token, for a specified user account. The current user who is logging in to REST service must have the Administrator permission to use this API.
API path: /api/v1/security/deleteAuthToken/username
Sample usage: http://<server>:<port>/api/v1/security/deleteAuthToken/abcuser

Accept

String

Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

API Name: Set Auth Token for the current user
Description: Set the Auth Token, which is also referred to as digital token, for the current login user.
API path: /api/v1/security/setOwnAuthToken
Sample usage: http://<server>:<port>/api/v1/security/setOwnAuthToken

Accept

String

Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

API Name: Delete Auth Token for the current user
Description: Delete the Auth Token, which is also referred to as digital token, for the current login user.
API path: /api/v1/security/deleteOwnAuthToken
Sample usage: http://<server>:<port>/api/v1/security/deleteOwnAuthToken

Accept

String

Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

Agent

The Agent related APIs include the following:

API Name: Get agent by agent ID.
Description: Filter out agents by the agent ID.
API path: /api/v1/agent/agentId/agentId
Sample usage: http://<server>:<port>/api/v1/agent/agentId/1
API Name: Get all active agents.
Description: Filter out all active agents.
API path: /api/v1/agent/active
Sample usage: http://<server>:<port>/api/v1/agent/active
API Name: Get all agents.
Description: Get all agents.
API path: /api/v1/agent/allAgents
Sample usage: http://<server>:<port>/api/v1/agent/allAgents
API Name: Get all inactive agents.
Description: Filter out all inactive agents.
API path: /api/v1/agent/inactive
Sample usage: http://<server>:<port>/api/v1/agent/inactive
API Name: Start agent by agent ID.
Description: Active agent and then start data collection by agent ID.
API path: /api/v1/agent/start/agentId/:agentId
Sample usage: http://<server>:<port>/api/v1/agent/start/agentId/1

Access- Token

String

The token you get after you login successfully.

Accept

String

Should be application/json or application/xml, to define the response data format, default is application/json.

API Name: Stop agent by agent ID.
Description: Stop data collection and then deactivate agent by agent ID.
API path: /api/v1/agent/stop/agentId/:agentId
Sample usage: http://<server>:<port>/api/v1/agent/stop/agentId/1

Access- Token

String

The token you get after you login successfully.

Accept

String

Should be application/json or application/xml, to define the response data format, default is application/json.

API Name: Delete agent by agent ID.
Description: Delete an agent by agent ID.
API path: /api/v1/agent/delete/agentId/:agentId
Sample usage: http://<server>:<port>/api/v1/agent/delete/agentId/1

Access- Token

String

The token you get after you login successfully.

Accept

String

Should be application/json or application/xml, to define the response data format, default is application/json.

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating