Chat now with support
Chat with Support

Foglight 5.9.1 - REST API Reference Guide

TopologyType

The TopologyType related APIs include the following:

•
TopologyType — Get type information
•
TopologyType — Get type super type’s information
•
TopologyType — Get all instances of a type
TopologyType — Get type information
•
API Name: Get type information
•
Description: Get the information of an type.
•
Request type: GET
•
API path: /api/v1/type/typeName
•
Sample usage: http://<server>:<port>/api/v1/type/Host
•
Header:
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.

•
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.

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

•
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.

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

•
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.

User Information

The User Information related API includes the following:

•
User Information — Get current user information
User Information — Get current user information
•
API Name: Get current user information
•
Description: Get the information of the current user.
•
Request type: GET
•
API path: /api/v1/user/current
•
Sample usage: http://<server>:<port>/api/v1/user/current
•
Header:
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.

•
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.

 

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating