PingKong/config.example.json at main · armas77/PingKong · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
{
  "endpoints": [
    {
      "name": "Main API",
      "url": "https://api.example.com/health",
      "strategy": "http",
      "timeoutSeconds": 10
    },
    {
      "name": "TCP Service",
      "url": "tcp://db.example.internal:5432",
      "strategy": "telnet"
    },
    {
      "name": "API with Basic Auth",
      "url": "https://api.example.com/status",
      "strategy": "http",
      "auth": {
        "type": "basic",
        "username": "example_user",
        "password": "example_password"
      }
    },
    {
      "name": "API with Bearer",
      "url": "https://api.example.com/v1/ping",
      "strategy": "http",
      "auth": {
        "type": "bearer",
        "token": "REPLACE_WITH_YOUR_JWT_OR_ACCESS_TOKEN"
      }
    },
    {
      "name": "API with API Key",
      "url": "https://api.example.com/check",
      "strategy": "http",
      "auth": {
        "type": "apikey",
        "header": "X-API-Key",
        "value": "REPLACE_WITH_YOUR_API_KEY"
      }
    },
    {
      "name": "API OAuth Client Credentials",
      "url": "https://api.example.com/protected",
      "strategy": "http",
      "auth": {
        "type": "oauth_client",
        "tokenUrl": "https://auth.example.com/oauth/token",
        "clientId": "REPLACE_WITH_CLIENT_ID",
        "clientSecret": "REPLACE_WITH_CLIENT_SECRET"
      }
    },
    {
      "name": "API (custom headers)",
      "url": "https://api.example.com/protected",
      "strategy": "http",
      "auth": {
        "type": "custom_headers",
        "headers": {
          "client_id": "mock_client_id_xxxxxxxxxxxxxxxx",
          "secret": "mock_secret_xxxxxxxx",
          "Content-Type": "application/json",
          "X-Custom-Context": "{\"identity\":{\"userRoles\":[\"example_role\"]}}"
        }
      }
    },
    {
      "name": "Bearer from token endpoint (POST token then POST API)",
      "url": "https://api.example-vendor.com/v1/Document",
      "strategy": "http",
      "httpMethod": "POST",
      "contentType": "application/json",
      "body": {
        "date_From": "20200101",
        "date_To": "20201231",
        "page_Offset": 1,
        "limit": 10,
        "documents": [
          {
            "id": "000000000"
          }
        ]
      },
      "auth": {
        "type": "bearer_from_token",
        "tokenUrl": "https://api.example-vendor.com/v1/Token",
        "tokenMethod": "POST",
        "tokenResponseField": "access_token",
        "tokenBody": {
          "api_Key": "REPLACE_WITH_API_KEY",
          "api_Secret": "REPLACE_WITH_API_SECRET"
        }
      }
    },
    {
      "name": "FTP server (connection + folders)",
      "url": "ftp://ftp.example.com:21",
      "strategy": "ftp",
      "timeoutSeconds": 30,
      "ftp": {
        "username": "REPLACE_WITH_FTP_USER",
        "password": "REPLACE_WITH_FTP_PASSWORD",
        "useSsl": false,
        "folders": [
          "/incoming",
          "/outgoing/archive"
        ]
      }
    }
  ]
}