phpExt / Datadog API Collection / Edit an application key owned by current user
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// 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>",
// "scopes": [
// "<string>",
// "<string>"
// ]
// },
// "id": "<string>",
// "type": "application_keys"
// }
// }
$json = new CkJsonObject();
$json->UpdateString('data.attributes.name','<string>');
$json->UpdateString('data.attributes.scopes[0]','<string>');
$json->UpdateString('data.attributes.scopes[1]','<string>');
$json->UpdateString('data.id','<string>');
$json->UpdateString('data.type','application_keys');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');
$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
// resp is a CkHttpResponse
$resp = $http->PTextSb('PATCH','https://api.app.ddog-gov.com/api/v2/current_user/application_keys/:app_key_id',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "created_at": "<string>",
// "key": "<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
$Created_at = $jResp->stringOf('data.attributes.created_at');
$Key = $jResp->stringOf('data.attributes.key');
$Last4 = $jResp->stringOf('data.attributes.last4');
$Name = $jResp->stringOf('data.attributes.name');
$Id = $jResp->stringOf('data.id');
$DataId = $jResp->stringOf('data.relationships.owned_by.data.id');
$v_Type = $jResp->stringOf('data.relationships.owned_by.data.type');
$dataType = $jResp->stringOf('data.type');
$i = 0;
$count_i = $jResp->SizeOfArray('data.attributes.scopes');
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf('data.attributes.scopes[i]');
$i = $i + 1;
}
$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');
$Modified_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;
}
$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;
}
$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;
}
$i = $i + 1;
}
?>
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"name": "<string>",
"scopes": [
"<string>",
"<string>"
]
},
"id": "<string>",
"type": "application_keys"
}
}'
https://api.app.ddog-gov.com/api/v2/current_user/application_keys/:app_key_id
Postman Collection Item JSON
{
"name": "Edit an application key owned by current user",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"<string>\",\n \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id",
"value": "<string>"
}
]
},
"description": "Edit an application key owned by current user"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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 \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"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 \"key\": \"<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": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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 \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"key": "app_key_id"
}
]
}
},
"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": "PATCH",
"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 \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"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": "PATCH",
"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 \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"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": "PATCH",
"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 \"scopes\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"application_keys\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/current_user/application_keys/:app_key_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"current_user",
"application_keys",
":app_key_id"
],
"variable": [
{
"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}"
}
]
}
