Chilkat Online Tools

Ruby / Datadog API Collection / Create an API key

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "data": {
#     "attributes": {
#       "name": "<string>"
#     },
#     "type": "api_keys"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("data.attributes.name","<string>")
json.UpdateString("data.type","api_keys")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/api_keys","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

Created_at = jResp.stringOf("data.attributes.created_at")
Key = jResp.stringOf("data.attributes.key")
Last4 = jResp.stringOf("data.attributes.last4")
Modified_at = jResp.stringOf("data.attributes.modified_at")
Name = jResp.stringOf("data.attributes.name")
Id = jResp.stringOf("data.id")
DataId = jResp.stringOf("data.relationships.created_by.data.id")
v_Type = jResp.stringOf("data.relationships.created_by.data.type")
DataId = jResp.stringOf("data.relationships.modified_by.data.id")
DataType = jResp.stringOf("data.relationships.modified_by.data.type")
dataType = jResp.stringOf("data.type")
i = 0
count_i = jResp.SizeOfArray("included")
while i < count_i
    jResp.put_I(i)
    attributesCreated_at = jResp.stringOf("included[i].attributes.created_at")
    Disabled = jResp.stringOf("included[i].attributes.disabled")
    v_Email = jResp.stringOf("included[i].attributes.email")
    Handle = jResp.stringOf("included[i].attributes.handle")
    Icon = jResp.stringOf("included[i].attributes.icon")
    attributesModified_at = jResp.stringOf("included[i].attributes.modified_at")
    attributesName = jResp.stringOf("included[i].attributes.name")
    Service_account = jResp.stringOf("included[i].attributes.service_account")
    Status = jResp.stringOf("included[i].attributes.status")
    Title = jResp.stringOf("included[i].attributes.title")
    Verified = jResp.stringOf("included[i].attributes.verified")
    id = jResp.stringOf("included[i].id")
    DataId = jResp.stringOf("included[i].relationships.org.data.id")
    DataType = jResp.stringOf("included[i].relationships.org.data.type")
    v_type = jResp.stringOf("included[i].type")
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.other_orgs.data")
    while j < count_j
        jResp.put_J(j)
        id = jResp.stringOf("included[i].relationships.other_orgs.data[j].id")
        v_type = jResp.stringOf("included[i].relationships.other_orgs.data[j].type")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.other_users.data")
    while j < count_j
        jResp.put_J(j)
        id = jResp.stringOf("included[i].relationships.other_users.data[j].id")
        v_type = jResp.stringOf("included[i].relationships.other_users.data[j].type")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.roles.data")
    while j < count_j
        jResp.put_J(j)
        id = jResp.stringOf("included[i].relationships.roles.data[j].id")
        v_type = jResp.stringOf("included[i].relationships.roles.data[j].type")
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "name": "<string>"
    },
    "type": "api_keys"
  }
}'
https://api.app.ddog-gov.com/api/v2/api_keys

Postman Collection Item JSON

{
  "name": "Create an API key",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"type\": \"api_keys\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/api_keys",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "api_keys"
      ]
    },
    "description": "Create an API key."
  },
  "response": [
    {
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys"
          ]
        }
      },
      "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": "Too many requests",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys"
          ]
        }
      },
      "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}"
    }
  ]
}