Chat now with support
Chat with Support

Foglight 5.9.1 - REST API Reference Guide

TopologyType

The TopologyType related APIs include the following:

API Name: Get type information
Description: Get the information of an type.
API path: /api/v1/type/typeName
Sample usage: http://<server>:<port>/api/v1/type/Host

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.

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 type super type’s information
Description: Get the information of a type’s parent type.
API path: /api/v1/type/typeName/super
Sample usage: http://<server>:<port>/api/v1/type/Host/super

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.

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 instances of a type
Description: Get all instances of a type.
API path: /api/v1/type/typeName/instances
Sample usage: http://<server>:<port>/api/v1/type/Host/instances

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.

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.

User Information

The User Information related API includes the following:

API Name: Get current user information
Description: Get the information of the current user.
API path: /api/v1/user/current
Sample usage: http://<server>:<port>/api/v1/user/current

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.

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.

 

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating