Chilkat Online Tools

Swift3 / Datadog API Collection / Get API key

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    let queryParams = CkoJsonObject()!
    queryParams.update("include", value: "<string>")

    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "data": {
    //     "attributes": {
    //       "created_at": "<string>",
    //       "key": "<string>",
    //       "last4": "<string>",
    //       "modified_at": "<string>",
    //       "name": "<string>"
    //     },
    //     "id": "<string>",
    //     "relationships": {
    //       "created_by": {
    //         "data": {
    //           "id": "<string>",
    //           "type": "users"
    //         }
    //       },
    //       "modified_by": {
    //         "data": {
    //           "id": "<string>",
    //           "type": "users"
    //         }
    //       }
    //     },
    //     "type": "api_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

    var attributesCreated_at: String?
    var Disabled: String?
    var v_Email: String?
    var Handle: String?
    var Icon: String?
    var attributesModified_at: String?
    var attributesName: String?
    var Service_account: String?
    var Status: String?
    var Title: String?
    var Verified: String?
    var id: String?
    var v_type: String?
    var j: Int
    var count_j: Int

    var Created_at: String? = jResp.string(of: "data.attributes.created_at")
    var Key: String? = jResp.string(of: "data.attributes.key")
    var Last4: String? = jResp.string(of: "data.attributes.last4")
    var Modified_at: String? = jResp.string(of: "data.attributes.modified_at")
    var Name: String? = jResp.string(of: "data.attributes.name")
    var Id: String? = jResp.string(of: "data.id")
    var DataId: String? = jResp.string(of: "data.relationships.created_by.data.id")
    var v_Type: String? = jResp.string(of: "data.relationships.created_by.data.type")
    DataId = jResp.string(of: "data.relationships.modified_by.data.id")
    var DataType: String? = jResp.string(of: "data.relationships.modified_by.data.type")
    var dataType: String? = jResp.string(of: "data.type")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "included").intValue
    while i < count_i {
        jResp.i = i
        attributesCreated_at = jResp.string(of: "included[i].attributes.created_at")
        Disabled = jResp.string(of: "included[i].attributes.disabled")
        v_Email = jResp.string(of: "included[i].attributes.email")
        Handle = jResp.string(of: "included[i].attributes.handle")
        Icon = jResp.string(of: "included[i].attributes.icon")
        attributesModified_at = jResp.string(of: "included[i].attributes.modified_at")
        attributesName = jResp.string(of: "included[i].attributes.name")
        Service_account = jResp.string(of: "included[i].attributes.service_account")
        Status = jResp.string(of: "included[i].attributes.status")
        Title = jResp.string(of: "included[i].attributes.title")
        Verified = jResp.string(of: "included[i].attributes.verified")
        id = jResp.string(of: "included[i].id")
        DataId = jResp.string(of: "included[i].relationships.org.data.id")
        DataType = jResp.string(of: "included[i].relationships.org.data.type")
        v_type = jResp.string(of: "included[i].type")
        j = 0
        count_j = jResp.size(ofArray: "included[i].relationships.other_orgs.data").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "included[i].relationships.other_orgs.data[j].id")
            v_type = jResp.string(of: "included[i].relationships.other_orgs.data[j].type")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "included[i].relationships.other_users.data").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "included[i].relationships.other_users.data[j].id")
            v_type = jResp.string(of: "included[i].relationships.other_users.data[j].type")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "included[i].relationships.roles.data").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "included[i].relationships.roles.data[j].id")
            v_type = jResp.string(of: "included[i].relationships.roles.data[j].type")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -G -d "include=%3Cstring%3E"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id

Postman Collection Item JSON

{
  "name": "Get API key",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id?include=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "api_keys",
        ":api_key_id"
      ],
      "query": [
        {
          "key": "include",
          "value": "<string>",
          "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
        }
      ],
      "variable": [
        {
          "key": "api_key_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get an API key."
  },
  "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/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_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      \"key\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"modified_at\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"created_by\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"users\"\n        }\n      },\n      \"modified_by\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"users\"\n        }\n      }\n    },\n    \"type\": \"api_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/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_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/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_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/api_keys/:api_key_id?include=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`."
            }
          ],
          "variable": [
            {
              "key": "api_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}"
    }
  ]
}