• |
• |
• |
• |
• |
• |
• |
• |
The App related API includes the following:
• |
API Name: Get App information |
• |
Description: Get the application information. |
• |
Request type: GET |
• |
API path: /api/v1/ |
• |
Sample usage: http://<server>:<port>/api/v1/ |
• |
The token is retrieved after successfully logging in to the Management Server. Note: Refer to Authentication for more information. | ||
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
The Security related APIs include the following:
• |
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.
|
• |
Request type: POST |
• |
API path: /api/v1/security/login |
• |
Sample usage: http://<server>:<port>/api/v1/security/login |
• |
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
The token is generated from the User Management dashboard or Foglight command line. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
• |
API Name: Logout |
• |
Description: Expire an access token. |
• |
Request type: GET |
• |
API path: /api/v1/security/logout |
• |
Sample usage: http://<server>:<port>/api/v1/security/logout |
• |
The token is retrieved after successfully logging in to the Management Server. Note: Refer to Authentication for more information. | ||
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format data (JSON/XML) or exception message | ||
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. |
• |
Request type: GET |
• |
API path: /api/v1/security/setAuthToken/username |
• |
Sample usage: http://<server>:<port>/api/v1/security/setAuthToken/abcuser |
• |
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
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. |
• |
Request type: GET |
• |
API path: /api/v1/security/deleteAuthToken/username |
• |
Sample usage: http://<server>:<port>/api/v1/security/deleteAuthToken/abcuser |
• |
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
• |
Either the response data format (JSON/XML) or exception message. | ||
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. |
• |
Request type: GET |
• |
API path: /api/v1/security/setOwnAuthToken |
• |
Sample usage: http://<server>:<port>/api/v1/security/setOwnAuthToken |
• |
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
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. |
• |
Request type: GET |
• |
API path: /api/v1/security/deleteOwnAuthToken |
• |
Sample usage: http://<server>:<port>/api/v1/security/deleteOwnAuthToken |
• |
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
The Agent related APIs include the following:
• |
API Name: Get agent by agent ID. |
• |
Description: Filter out agents by the agent ID. |
• |
Request type: GET |
• |
API path: /api/v1/agent/agentId/agentId |
• |
Sample usage: http://<server>:<port>/api/v1/agent/agentId/1 |
• |
The token is retrieved after successfully logging in to the Management Server. Note: Refer to Authentication for more information. | ||
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
• |
API Name: Get all active agents. |
• |
Description: Filter out all active agents. |
• |
Request type: GET |
• |
API path: /api/v1/agent/active |
• |
Sample usage: http://<server>:<port>/api/v1/agent/active |
• |
The token is retrieved after successfully logging in to the Management Server. Note: Refer to Authentication for more information. | ||
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
• |
API Name: Get all agents. |
• |
Description: Get all agents. |
• |
Request type: GET |
• |
API path: /api/v1/agent/allAgents |
• |
Sample usage: http://<server>:<port>/api/v1/agent/allAgents |
• |
The token is retrieved after successfully logging in to the Management Server. Note: Refer to Authentication for more information. | ||
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
• |
API Name: Get all inactive agents. |
• |
Description: Filter out all inactive agents. |
• |
Request type: GET |
• |
API path: /api/v1/agent/inactive |
• |
Sample usage: http://<server>:<port>/api/v1/agent/inactive |
• |
The token is retrieved after successfully logging in to the Management Server. Note: Refer to Authentication for more information. | ||
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
• |
API Name: Start agent by agent ID. |
• |
Description: Active agent and then start data collection by agent ID. |
• |
Request type: POST |
• |
API path: /api/v1/agent/start/agentId/:agentId |
• |
Sample usage: http://<server>:<port>/api/v1/agent/start/agentId/1 |
• |
Should be application/json or application/xml, to define the response data format, default is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
• |
API Name: Stop agent by agent ID. |
• |
Description: Stop data collection and then deactivate agent by agent ID. |
• |
Request type: POST |
• |
API path: /api/v1/agent/stop/agentId/:agentId |
• |
Sample usage: http://<server>:<port>/api/v1/agent/stop/agentId/1 |
• |
Should be application/json or application/xml, to define the response data format, default is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
• |
API Name: Delete agent by agent ID. |
• |
Description: Delete an agent by agent ID. |
• |
Request type: DELETE |
• |
API path: /api/v1/agent/delete/agentId/:agentId |
• |
Sample usage: http://<server>:<port>/api/v1/agent/delete/agentId/1 |
• |
Should be application/json or application/xml, to define the response data format, default is application/json. |
Either the response data format (JSON/XML) or exception message. | ||
Error code if some exception occurs; otherwise this field is not shown. |
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Términos de uso Privacidad Cookie Preference Center