Viewing the meta information

Viewing the project list

GET https://api.whatap.io/open/api/json/projects

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/projects"

response
{
  "data": [ {
        "groupName": "",
        "projectCode": 35,
        "projectName": "APM_TEST2",
        "createTime": "2018-10-19 07:17:03.774",
        "status": "subscribe",
        "productType": "APM",
        "platform": "JAVA",
        "gatewayName": "LOCAL",
        "apiToken": "5**********************R"
    }, {
    }, (...)
  ],
  "accountEmail": "xxx@whatap.io",
  "total": 6
}

Response Field	Field Type	Description
gourpName	string	Name of the project's upper group
projectCode	number	pcode
projectName	string	프로젝트 이름
createTime	string	Project creation date
lastUpdatedTime	string	Project modification date
status	string	Project status
productType	string	Application server type
platform	string	Application server platform
gatewayName	string	Gateway name
apiToken	string	Project API token
accountEmail	string	Email address of the user account
total	number	Project count

Viewing the project information

GET https://api.whatap.io/open/api/json/project

Note

This function is included in the application monitoring suite.

command
$ curl -L -w "\n" -H "x-whatap-token: {{PROJECT API TOKEN}}" -H "x-whatap-pcode: {{projectCode}}" "https://api.whatap.io/open/api/json/project"

response
{
  "platform": "JAVA",
  "createTime": "Tue Sep 18 08:34:27 GMT 2018",
  "gatewayName": "Office-OTE",
  "projectCode": 1**1,
  "status": "Subscribe",
  "lastUpdatedTime": "Tue Sep 18 08:34:34 GMT 2018", 
  "name": "SEO_APM",
  "productType": "APM"
}

Response Field	Field Type	Description
platform	string	Application server platform
createTime	string	Project creation date
projectCode	number	pcode
status	string	Project status
lastUpdatedTime	string	Project modification date
productType	string	Application server type

Viewing the project information and server details

GET https://api.whatap.io/open/api/json/projects

Note

This function is included in the server monitoring suite.

command
$ curl -L -w "\n" -H "x-whatap-token: {{PROJECT API TOKEN}}" -H "x-whatap-pcode: {{projectCode}}" "https://api.whatap.io/open/api/json/project"

response
{
  "pname":"LOCAL_PC",
  "timezone":9,
  "regionName":"LOCAL",
  "values":{
    "servers":[
      {
        "public_ip":"192.168.1.0",
        "os_cpuvendor":"Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz",
        "agent_created":"1572406071216",
        "ip":"192.168.1.0",
        "os_arch":"amd64",
        "actTime":1572406264112,
        "cpu_cores":"8",
        "oid":-1030311093,
        "isActive":true,
        "okind":"",
        "version":"1.2.4",
        "tags":[
          "network:169.254.0.0/16",
          "network:192.168.1.0/24",
          "java",
          "OpenVpn",
          "oracle",
          "ftp"
        ],
        "inactTime":0,
        "oname":"DESKTOP-KEIPLT5",
        "os_name":"windows",
        "startTime":1572406263602,
        "os_memory":"17036419072",
        "os_status":"warning"
      },
      (...)
    ],
  }
}

Viewing the project agent status and host

GET https://api.whatap.io/open/json/agents

command
$ curl -L -w "\n" -H "x-whatap-token: {{PROJECT API TOKEN}}" -H "x-whatap-pcode: {{projectCode}}" "https://api.whatap.io/open/json/agents"

response
{
   "data":[
      {
         "host_ip":"127.0.0.1",
         "oname":"TC-29-96-8082",
         "active":true
      }, { 
      } (...)
   ]
}

Viewing the project member list

GET https://api.whatap.io/open/api/json/project/projectCode/members

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/project/{{projectCode}}/members"

response
{
  "data": [ {
      "email": "honggildong@whatap.io",
      "name": "John Doe",
      "typeKey": "super_admin",
      "typeName": "Super Admin"
    }, {
    }, (...)
      ],
  "total": 6
}

Response Field	Field Type	Description
email	string	Email address of the user account
name	string	User account name
typeKey	string	User Role
typeName	string	Name of the user role
total	number	Project member count

Viewing the group list

GET https://api.whatap.io/open/api/json/groups

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/v2/json/groups"

response
{
  "data": [ {
        "groupName": "WHATAP APM",
        "groupKey": "grp****ab123kskd*****q",
        "description": "APM Group"
    }, {
    }, (...)
  ],
  "total": 3
}

Viewing the group member list

GET https://api.whatap.io/open/api/json/group/groupKey/members

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/group/{{groupKey}}/members"

response
{
  "data": [ {
      "groupName": "WHATAP APM",
      "groupKey": "AB123KSKD*****2uasQ",
      "description": "APM Group"
    }, {
    }, (...)
  ],
  "total": 3
}

Viewing the project in the group

GET https://api.whatap.io/open/api/json/group/groupKey/projects

This API views meta information of the projects in the group. You need your account's API token, and an example request using CURL is below.

command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/group/{{groupKey}}/projects" 

response
{
  "data": [
    {
      "projectCode":35,
      "name":"APM_TEST2",
      "status":"Subscribe",
      "productType":"APM",
      "platform":"JAVA",
      "gatewayName":"LOCAL"
    }, {
    }, (...)
  ]
}

Response Field	Field Type	Description
projectCode	number(integer)	pcode
name	string	Project name
status	string	Project status (`pending`, `trial`, `subscribe`, `close_pending`, `limited`, `closed`, `trial_limited`)
productType	string	Products used in the project
platform	string	Platform of the product used in the project
gatewayName	string	Data Server Region

Calling the oid list

You can search for active agents during queries.

POST https://api.whatap.io/open/api/v2/agent/list

request
curl --location 'https://api.whatap.io/open/api/v2/agent/list' -H 'x-whatap-token: {{PROJECT API TOKEN}}
' -H 'x-whatap-pcode: {{projectCode}}' -d '{"stime":1690850183000,"etime":1693321200000}'

response
{
    "stime": 1690850183000,
    "etime": 1693321200000,
    "timestamp": 1693388196965,
    "data": [
        {
            "oid": 757639646,
            "oname": "DBX-0-107-3306",
            "alias": "",
            "initial": "",
            "otype": "database",
            "subtype": "0",
            "active": false,
            "okind": 0,
            "okindName": "",
            "onode": 0,
            "onodeName": "",
            "ip": "",
            "agent.version": "",
            "cpuCores": 0
        },
      ...
    ]
}

Note

Among the sample codes in this document, change the stime and etime parameter values for your environment. Parameter values can be requested using various formats.
- 1693475430087 (unix timestamp)
- yyyyMMddHHmmss
- yyyyMMddHHmm
- MMddHHmmss
- MMddHHmm
The inquiry time (stime, etime) is limited to one day and its unit is ms (millisecond).

Viewing the project list​

Viewing the project information​

Viewing the project information and server details​

Viewing the project agent status and host​

Viewing the project member list​

Viewing the group list​

Viewing the group member list​

Viewing the project in the group​

Calling the oid list​

Viewing the project list

Viewing the project information

Viewing the project information and server details

Viewing the project agent status and host

Viewing the project member list

Viewing the group list

Viewing the group member list

Viewing the project in the group

Calling the oid list