Overview¶

Guance Open API is a simplified HTTP REST API. * Only GET / POST requests * Use resource-oriented URLs to call the API * Use status codes to indicate whether the request was successful or failed * All requests return JSON structures * Open API programmatically accesses the Guance platform

Supported Endpoints¶

Common Request Header (Header)¶

Authentication Method¶

The interface uses API KEY as the authentication method. For each request, the value of DF-API-KEY in the request body's Header is used for validity checks and as the basis for limiting the workspace for this request (takes the workspace to which this DF-API-KEY belongs).

All interfaces displayed by the current Open API only require providing the API KEY (Header: DF-API-KEY) as credentials. If the credentials exist and are valid, it is considered authenticated.

Common Response Structure¶

Request Example¶

GET Request¶

Example using the dashboard list retrieval interface¶

Request as follows:

curl "https://openapi.guance.com/api/v1/dashboards/list?pageIndex=1&pageSize=10" \
  -H "Content-Type: application/json" \
  -H "DF-API-KEY: ${DF_API_KEY}" \
  --compressed \
  --insecure

Response result as follows:

{
    "code":200,
    "content":[
        {Object}
    ],
    "errorCode":"",
    "message":"",
    "pageInfo":{
        "count":10,
        "pageIndex":1,
        "pageSize":10,
        "totalCount":836
    },
    "success":true,
    "traceId":"1749091119335873001"
}

POST Request¶

Example using the delete dashboard interface¶

Request as follows:

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

Response result as follows:

{
    "code":200,
    "content":true,
    "errorCode":"",
    "message":"",
    "success":true,
    "traceId":"4250149955169518608"
}