Foglight 5.9.5 - REST API Reference Guide

Security — Set Auth Token for a given user


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

Security

•

Security — Login

•

Security — Logout

•

•

Security — Delete Auth Token for a given user

•

Security — Set Auth Token for current user

•

Security — Delete Auth Token for current user

Security — Login

•

API Name: Login

•

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. NOTE: The associated user account should be granted with the API Access role.

•

Request type: POST

•

API path: /api/v1/security/login

•

Sample usage: http://<server>:<port>/api/v1/security/login

•


Field	Type	Description
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Parameter:


Field	Type	Description
username	String	User account.
pwd	String	Password associated with the user account.
authToken	String	The token is generated from the User Management dashboard or Foglight command line. NOTE: This parameter is only available in Foglight release 5.7.5.7 or later.

•


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

Security — Logout

•

API Name: Logout

•

Description: Expire an access token.

•

•

API path: /api/v1/security/logout

•

Sample usage: http://<server>:<port>/api/v1/security/logout

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Security — Set Auth Token for a given user


Field	Type	Description
status	String	The response status
data	String	Either the response data format data (JSON/XML) or exception message
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

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.


	NOTE: This API is only available in the Foglight Management Server 5.7.5.7 or later.

After setting a token for the specified user, the old token (if exists) is expired. This causes the login status of this user is also expired, if this user has logged in to REST service. This user should log in to the REST service again using the new authToken or credentials.

•

•

API path: /api/v1/security/setAuthToken/username

•

Sample usage: http://<server>:<port>/api/v1/security/setAuthToken/abcuser

•


Field	Type	Description
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Parameter:


Field	Type	Description
username	String	User account which Auth Token is to be set.

•

Security — Delete Auth Token for a given user


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

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.


	NOTE: This API is only available in the Foglight Management Server 5.7.5.7 or later.

After deleting a token for the specified user, the old token (if exists) is expired. This causes the login status of this user is also expired, if this user has logged in to REST service.

•

•

API path: /api/v1/security/deleteAuthToken/username

•

Sample usage: http://<server>:<port>/api/v1/security/deleteAuthToken/abcuser

•

Security — Set Auth Token for current user


Field	Type	Description
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Parameter:


Field	Type	Description
username	String	User account which Auth Token is to be deleted.

•

Returned value: —


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

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.


	NOTE: This API is only available in the Foglight Management Server 5.7.5.7 or later.

After setting a token for the current user, the old token (if exists) is expired. This causes the login status of current user is also expired. The current user should log in to the REST service again using the new authToken or credentials.

•

•

API path: /api/v1/security/setOwnAuthToken

•

Sample usage: http://<server>:<port>/api/v1/security/setOwnAuthToken

•


Field	Type	Description
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Security — Delete Auth Token for current user


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

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.


	NOTE: This API is only available in the Foglight Management Server 5.7.5.7 or later.

After deleting a token for the current user, the old token (if exists) is expired. This causes the login status of current user is also expired. The current user should log in to the REST service again using user credentials.

•

•

API path: /api/v1/security/deleteOwnAuthToken

•

Sample usage: http://<server>:<port>/api/v1/security/deleteOwnAuthToken

•


Field	Type	Description
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Agent — Get agent by agent ID


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

Agent

•

•

Agent — Get all active agents

•

Agent — Get all agents

•

Agent — Get all inactive agents

Agent — Get agent by agent ID

•

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

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Agent — Get all active agents


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

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

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

Agent — Get all agents

•

API Name: Get all agents

•

Description: Get all agents.

•

•

API path: /api/v1/agent/allAgents

•

Sample usage: http://<server>:<port>/api/v1/agent/allAgents

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Agent — Get all inactive agents


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

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

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•