OpenAPI¶

Guance supports obtaining and updating Guance workspace data through calling Open API interfaces.

For detailed API lists, refer to the Guance OpenAPI Documentation Library.

Authentication Method¶

Before calling API interfaces, you need to create an API Key for authentication.

For instructions on creating an API Key, refer to API Key Management.

The interface uses API KEY as the authentication method. Each request uses the value of the DF-API-KEY in the request header for validation and to determine the workspace for this request (based on the workspace associated with this DF-API-KEY).

All GET (data query and retrieval) interfaces only require providing the API KEY (Header: DF-API-KEY) as credentials.

Request Structure¶

Example of a URL POST request to delete a dashboard:

curl -X POST "https://openapi.guance.com/api/v1/dashboard/dsbd_922428e594ba44ce87229b8ca3007a90/delete" \
-H "Content-Type: application/json" \
-H "DF-API-KEY: ${DF_API_KEY}"

Example of a URL GET request to validate:

curl -X GET "https://openapi.guance.com/api/v1/validate" \
-H "Content-Type: application/json" \
-H "DF-API-KEY: ${DF_API_KEY}"

Note: We have simplified HTTP request methods to use only GET and POST. GET is used for data retrieval requests, such as the [Get Dashboard List] interface, while POST is used for all data modification requests, such as [Create Dashboard, Delete Dashboard] interfaces, etc.

Access Address Endpoint¶

Note: Private deployment versions also support OpenAPI access, using the actual deployment Endpoint.

Interface Routing Address Specification¶

Interface routing generally follows these naming conventions:

For example:

• Get dashboard list: /api/v1/dashboard/list
• Create a dashboard: /api/v1/dashboard/create
• Get a dashboard: /api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/get
• Delete a dashboard: /api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/delete
• Modify a dashboard: /api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/modify
• Get host object list: /api/v1/object/host/list
• Get process object list: /api/v1/object/process/list

Note: The v1 in the route is the API version number. Each released version of the API must be backward compatible. If there are incompatible changes or significant business changes, a new version number should be added.

Response Results¶

API responses follow HTTP request-response standards. A successful request returns an HTTP status code of 200, an invalid API KEY returns an HTTP status code of 403, and all other server-side unhandled or unknown errors return an HTTP status code of 500, such as accessing unauthorized data returning 403, or not finding an operation object returning 404, etc. Refer to the error definitions for more details.

Response Result Example¶

{
    "code":200,
    "content":{

    },
    "pageInfo": {
        "count": 20,
        "pageIndex": 1,
        "pageSize": 100,
        "totalCount": 10
    },
    "errorCode":"",
    "message":"",
    "success":true,
    "traceId":"3412000720344969928"
}

Common Response Result Parameters¶

Common Error Definitions¶

For more about API interface lists, refer to the Guance OpenAPI Documentation Library.