Chilkat Online Tools

PureBasic / Datadog API Collection / Get one application key for this service account

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "data": {
    ;     "attributes": {
    ;       "created_at": "<string>",
    ;       "last4": "<string>",
    ;       "name": "<string>",
    ;       "scopes": [
    ;         "<string>",
    ;         "<string>"
    ;       ]
    ;     },
    ;     "id": "<string>",
    ;     "relationships": {
    ;       "owned_by": {
    ;         "data": {
    ;           "id": "<string>",
    ;           "type": "users"
    ;         }
    ;       }
    ;     },
    ;     "type": "application_keys"
    ;   },
    ;   "included": [
    ;     {
    ;       "attributes": {
    ;         "created_at": "<dateTime>",
    ;         "disabled": "<boolean>",
    ;         "email": "<string>",
    ;         "handle": "<string>",
    ;         "icon": "<string>",
    ;         "modified_at": "<dateTime>",
    ;         "name": "<string>",
    ;         "service_account": "<boolean>",
    ;         "status": "<string>",
    ;         "title": "<string>",
    ;         "verified": "<boolean>"
    ;       },
    ;       "id": "<string>",
    ;       "relationships": {
    ;         "org": {
    ;           "data": {
    ;             "id": "<string>",
    ;             "type": "orgs"
    ;           }
    ;         },
    ;         "other_orgs": {
    ;           "data": [
    ;             {
    ;               "id": "<string>",
    ;               "type": "orgs"
    ;             },
    ;             {
    ;               "id": "<string>",
    ;               "type": "orgs"
    ;             }
    ;           ]
    ;         },
    ;         "other_users": {
    ;           "data": [
    ;             {
    ;               "id": "<string>",
    ;               "type": "users"
    ;             },
    ;             {
    ;               "id": "<string>",
    ;               "type": "users"
    ;             }
    ;           ]
    ;         },
    ;         "roles": {
    ;           "data": [
    ;             {
    ;               "id": "<string>",
    ;               "type": "roles"
    ;             },
    ;             {
    ;               "id": "<string>",
    ;               "type": "roles"
    ;             }
    ;           ]
    ;         }
    ;       },
    ;       "type": "users"
    ;     },
    ;     {
    ;       "attributes": {
    ;         "created_at": "<dateTime>",
    ;         "disabled": "<boolean>",
    ;         "email": "<string>",
    ;         "handle": "<string>",
    ;         "icon": "<string>",
    ;         "modified_at": "<dateTime>",
    ;         "name": "<string>",
    ;         "service_account": "<boolean>",
    ;         "status": "<string>",
    ;         "title": "<string>",
    ;         "verified": "<boolean>"
    ;       },
    ;       "id": "<string>",
    ;       "relationships": {
    ;         "org": {
    ;           "data": {
    ;             "id": "<string>",
    ;             "type": "orgs"
    ;           }
    ;         },
    ;         "other_orgs": {
    ;           "data": [
    ;             {
    ;               "id": "<string>",
    ;               "type": "orgs"
    ;             },
    ;             {
    ;               "id": "<string>",
    ;               "type": "orgs"
    ;             }
    ;           ]
    ;         },
    ;         "other_users": {
    ;           "data": [
    ;             {
    ;               "id": "<string>",
    ;               "type": "users"
    ;             },
    ;             {
    ;               "id": "<string>",
    ;               "type": "users"
    ;             }
    ;           ]
    ;         },
    ;         "roles": {
    ;           "data": [
    ;             {
    ;               "id": "<string>",
    ;               "type": "roles"
    ;             },
    ;             {
    ;               "id": "<string>",
    ;               "type": "roles"
    ;             }
    ;           ]
    ;         }
    ;       },
    ;       "type": "users"
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    strVal.s
    attributesCreated_at.s
    Disabled.s
    v_Email.s
    Handle.s
    Icon.s
    Modified_at.s
    attributesName.s
    Service_account.s
    Status.s
    Title.s
    Verified.s
    id.s
    DataType.s
    v_type.s
    j.i
    count_j.i

    Created_at.s = CkJsonObject::ckStringOf(jResp,"data.attributes.created_at")
    Last4.s = CkJsonObject::ckStringOf(jResp,"data.attributes.last4")
    Name.s = CkJsonObject::ckStringOf(jResp,"data.attributes.name")
    Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
    DataId.s = CkJsonObject::ckStringOf(jResp,"data.relationships.owned_by.data.id")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"data.relationships.owned_by.data.type")
    dataType.s = CkJsonObject::ckStringOf(jResp,"data.type")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.scopes")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.scopes[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"included")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        attributesCreated_at = CkJsonObject::ckStringOf(jResp,"included[i].attributes.created_at")
        Disabled = CkJsonObject::ckStringOf(jResp,"included[i].attributes.disabled")
        v_Email = CkJsonObject::ckStringOf(jResp,"included[i].attributes.email")
        Handle = CkJsonObject::ckStringOf(jResp,"included[i].attributes.handle")
        Icon = CkJsonObject::ckStringOf(jResp,"included[i].attributes.icon")
        Modified_at = CkJsonObject::ckStringOf(jResp,"included[i].attributes.modified_at")
        attributesName = CkJsonObject::ckStringOf(jResp,"included[i].attributes.name")
        Service_account = CkJsonObject::ckStringOf(jResp,"included[i].attributes.service_account")
        Status = CkJsonObject::ckStringOf(jResp,"included[i].attributes.status")
        Title = CkJsonObject::ckStringOf(jResp,"included[i].attributes.title")
        Verified = CkJsonObject::ckStringOf(jResp,"included[i].attributes.verified")
        id = CkJsonObject::ckStringOf(jResp,"included[i].id")
        DataId = CkJsonObject::ckStringOf(jResp,"included[i].relationships.org.data.id")
        DataType = CkJsonObject::ckStringOf(jResp,"included[i].relationships.org.data.type")
        v_type = CkJsonObject::ckStringOf(jResp,"included[i].type")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"included[i].relationships.other_orgs.data")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            id = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_orgs.data[j].id")
            v_type = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_orgs.data[j].type")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"included[i].relationships.other_users.data")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            id = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_users.data[j].id")
            v_type = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_users.data[j].type")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"included[i].relationships.roles.data")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            id = CkJsonObject::ckStringOf(jResp,"included[i].relationships.roles.data[j].id")
            v_type = CkJsonObject::ckStringOf(jResp,"included[i].relationships.roles.data[j].type")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id

Postman Collection Item JSON

{
  "name": "Get one application key for this service account",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "service_accounts",
        ":service_account_id",
        "application_keys",
        ":app_key_id"
      ],
      "variable": [
        {
          "key": "service_account_id",
          "value": "<string>"
        },
        {
          "key": "app_key_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get an application key owned by this service account."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "service_accounts",
            ":service_account_id",
            "application_keys",
            ":app_key_id"
          ],
          "variable": [
            {
              "key": "service_account_id"
            },
            {
              "key": "app_key_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"name\": \"<string>\",\n      \"scopes\": [\n        \"<string>\",\n        \"<string>\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"owned_by\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"users\"\n        }\n      }\n    },\n    \"type\": \"application_keys\"\n  },\n  \"included\": [\n    {\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"disabled\": \"<boolean>\",\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"service_account\": \"<boolean>\",\n        \"status\": \"<string>\",\n        \"title\": \"<string>\",\n        \"verified\": \"<boolean>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"org\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          }\n        },\n        \"other_orgs\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            }\n          ]\n        },\n        \"other_users\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            }\n          ]\n        },\n        \"roles\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            }\n          ]\n        }\n      },\n      \"type\": \"users\"\n    },\n    {\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"disabled\": \"<boolean>\",\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"service_account\": \"<boolean>\",\n        \"status\": \"<string>\",\n        \"title\": \"<string>\",\n        \"verified\": \"<boolean>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"org\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          }\n        },\n        \"other_orgs\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            }\n          ]\n        },\n        \"other_users\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            }\n          ]\n        },\n        \"roles\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            }\n          ]\n        }\n      },\n      \"type\": \"users\"\n    }\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "service_accounts",
            ":service_account_id",
            "application_keys",
            ":app_key_id"
          ],
          "variable": [
            {
              "key": "service_account_id"
            },
            {
              "key": "app_key_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "service_accounts",
            ":service_account_id",
            "application_keys",
            ":app_key_id"
          ],
          "variable": [
            {
              "key": "service_account_id"
            },
            {
              "key": "app_key_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/service_accounts/:service_account_id/application_keys/:app_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "service_accounts",
            ":service_account_id",
            "application_keys",
            ":app_key_id"
          ],
          "variable": [
            {
              "key": "service_account_id"
            },
            {
              "key": "app_key_id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}