PHP (Extension) / Datadog API Collection / Create or update service definition
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$json->UpdateString('schema-version','v2.1');$json->UpdateString('dd-service','<string>');$json->UpdateString('application','<string>');$json->UpdateString('contacts[0].type','email');$json->UpdateString('contacts[0].contact','<email>');$json->UpdateString('contacts[0].name','<string>');$json->UpdateString('contacts[1].type','email');$json->UpdateString('contacts[1].contact','<email>');$json->UpdateString('contacts[1].name','<string>');$json->UpdateString('description','<string>');$json->UpdateNewObject('extensions.qui_6');$json->UpdateString('integrations.opsgenie.service-url','<string>');$json->UpdateString('integrations.opsgenie.region','US');$json->UpdateString('integrations.pagerduty.service-url','<string>');$json->UpdateString('lifecycle','<string>');$json->UpdateString('links[0].name','<string>');$json->UpdateString('links[0].type','repo');$json->UpdateString('links[0].url','<string>');$json->UpdateString('links[0].provider','<string>');$json->UpdateString('links[1].name','<string>');$json->UpdateString('links[1].type','runbook');$json->UpdateString('links[1].url','<string>');$json->UpdateString('links[1].provider','<string>');$json->UpdateString('tags[0]','<string>');$json->UpdateString('tags[1]','<string>');$json->UpdateString('team','<string>');$json->UpdateString('tier','<string>');$resp->GetBodySb($sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$jResp->put_I($i);$Github_html_url = $jResp->stringOf('data[i].attributes.meta.github-html-url');$Ingested_schema_version = $jResp->stringOf('data[i].attributes.meta.ingested-schema-version');$Ingestion_source = $jResp->stringOf('data[i].attributes.meta.ingestion-source');$Last_modified_time = $jResp->stringOf('data[i].attributes.meta.last-modified-time');$Origin = $jResp->stringOf('data[i].attributes.meta.origin');$Origin_detail = $jResp->stringOf('data[i].attributes.meta.origin-detail');$Schema_version = $jResp->stringOf('data[i].attributes.schema.schema-version');$Dd_service = $jResp->stringOf('data[i].attributes.schema.info.dd-service');$Description = $jResp->stringOf('data[i].attributes.schema.info.description');$Display_name = $jResp->stringOf('data[i].attributes.schema.info.display-name');$Service_tier = $jResp->stringOf('data[i].attributes.schema.info.service-tier');$v_Email = $jResp->stringOf('data[i].attributes.schema.contact.email');$Slack = $jResp->stringOf('data[i].attributes.schema.contact.slack');$Pagerduty = $jResp->stringOf('data[i].attributes.schema.integrations.pagerduty');$Application = $jResp->stringOf('data[i].attributes.schema.org.application');$Team = $jResp->stringOf('data[i].attributes.schema.org.team');$id = $jResp->stringOf('data[i].id');$v_type = $jResp->stringOf('data[i].type');$j = 0;$count_j = $jResp->SizeOfArray('data[i].attributes.meta.warnings');$jResp->put_J($j);$instance_location = $jResp->stringOf('data[i].attributes.meta.warnings[j].instance-location');$keyword_location = $jResp->stringOf('data[i].attributes.meta.warnings[j].keyword-location');$message = $jResp->stringOf('data[i].attributes.meta.warnings[j].message');$j = $j + 1;$j = 0;$count_j = $jResp->SizeOfArray('data[i].attributes.schema.external-resources');$jResp->put_J($j);$name = $jResp->stringOf('data[i].attributes.schema.external-resources[j].name');$v_type = $jResp->stringOf('data[i].attributes.schema.external-resources[j].type');$url = $jResp->stringOf('data[i].attributes.schema.external-resources[j].url');$j = $j + 1;$j = 0;$count_j = $jResp->SizeOfArray('data[i].attributes.schema.tags');$jResp->put_J($j);$strVal = $jResp->stringOf('data[i].attributes.schema.tags[j]');$j = $j + 1;$i = $i + 1;
?>
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"schema-version": "v2.1",
"dd-service": "<string>",
"application": "<string>",
"contacts": [
{
"type": "email",
"contact": "<email>",
"name": "<string>"
},
{
"type": "email",
"contact": "<email>",
"name": "<string>"
}
],
"description": "<string>",
"extensions": {
"qui_6": {}
},
"integrations": {
"opsgenie": {
"service-url": "<string>",
"region": "US"
},
"pagerduty": {
"service-url": "<string>"
}
},
"lifecycle": "<string>",
"links": [
{
"name": "<string>",
"type": "repo",
"url": "<string>",
"provider": "<string>"
},
{
"name": "<string>",
"type": "runbook",
"url": "<string>",
"provider": "<string>"
}
],
"tags": [
"<string>",
"<string>"
],
"team": "<string>",
"tier": "<string>"
}'
https://api.app.ddog-gov.com/api/v2/services/definitions
Postman Collection Item JSON
{
"name": "Create or update service definition",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schema-version\": \"v2.1\",\n \"dd-service\": \"<string>\",\n \"application\": \"<string>\",\n \"contacts\": [\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensions\": {\n \"qui_6\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"<string>\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"<string>\"\n }\n },\n \"lifecycle\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"runbook\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"team\": \"<string>\",\n \"tier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
},
"description": "Create or update service definition in the Datadog Service Catalog."
},
"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 \"schema-version\": \"v2.1\",\n \"dd-service\": \"<string>\",\n \"application\": \"<string>\",\n \"contacts\": [\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensions\": {\n \"qui_6\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"<string>\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"<string>\"\n }\n },\n \"lifecycle\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"runbook\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"team\": \"<string>\",\n \"tier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"<string>\",\n \"ingested-schema-version\": \"<string>\",\n \"ingestion-source\": \"<string>\",\n \"last-modified-time\": \"<string>\",\n \"origin\": \"<string>\",\n \"origin-detail\": \"<string>\",\n \"warnings\": [\n {\n \"instance-location\": \"<string>\",\n \"keyword-location\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"instance-location\": \"<string>\",\n \"keyword-location\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"<string>\",\n \"description\": \"<string>\",\n \"display-name\": \"<string>\",\n \"service-tier\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<email>\",\n \"slack\": \"<string>\"\n },\n \"extensions\": {\n \"Excepteur__84\": {},\n \"sit6cc\": {}\n },\n \"external-resources\": [\n {\n \"name\": \"<string>\",\n \"type\": \"wiki\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"dashboard\",\n \"url\": \"<string>\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"<string>\"\n },\n \"org\": {\n \"application\": \"<string>\",\n \"team\": \"<string>\"\n },\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n },\n {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"<string>\",\n \"ingested-schema-version\": \"<string>\",\n \"ingestion-source\": \"<string>\",\n \"last-modified-time\": \"<string>\",\n \"origin\": \"<string>\",\n \"origin-detail\": \"<string>\",\n \"warnings\": [\n {\n \"instance-location\": \"<string>\",\n \"keyword-location\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"instance-location\": \"<string>\",\n \"keyword-location\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"<string>\",\n \"description\": \"<string>\",\n \"display-name\": \"<string>\",\n \"service-tier\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<email>\",\n \"slack\": \"<string>\"\n },\n \"extensions\": {\n \"laboris_99d\": {},\n \"ad_7d0\": {}\n },\n \"external-resources\": [\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"url\",\n \"url\": \"<string>\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"<string>\"\n },\n \"org\": {\n \"application\": \"<string>\",\n \"team\": \"<string>\"\n },\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\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 \"schema-version\": \"v2.1\",\n \"dd-service\": \"<string>\",\n \"application\": \"<string>\",\n \"contacts\": [\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensions\": {\n \"qui_6\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"<string>\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"<string>\"\n }\n },\n \"lifecycle\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"runbook\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"team\": \"<string>\",\n \"tier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"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 \"schema-version\": \"v2.1\",\n \"dd-service\": \"<string>\",\n \"application\": \"<string>\",\n \"contacts\": [\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensions\": {\n \"qui_6\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"<string>\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"<string>\"\n }\n },\n \"lifecycle\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"runbook\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"team\": \"<string>\",\n \"tier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"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": "Conflict",
"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 \"schema-version\": \"v2.1\",\n \"dd-service\": \"<string>\",\n \"application\": \"<string>\",\n \"contacts\": [\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensions\": {\n \"qui_6\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"<string>\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"<string>\"\n }\n },\n \"lifecycle\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"runbook\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"team\": \"<string>\",\n \"tier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"status": "Conflict",
"code": 409,
"_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 \"schema-version\": \"v2.1\",\n \"dd-service\": \"<string>\",\n \"application\": \"<string>\",\n \"contacts\": [\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"type\": \"email\",\n \"contact\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"extensions\": {\n \"qui_6\": {}\n },\n \"integrations\": {\n \"opsgenie\": {\n \"service-url\": \"<string>\",\n \"region\": \"US\"\n },\n \"pagerduty\": {\n \"service-url\": \"<string>\"\n }\n },\n \"lifecycle\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"runbook\",\n \"url\": \"<string>\",\n \"provider\": \"<string>\"\n }\n ],\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"team\": \"<string>\",\n \"tier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions"
]
}
},
"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}"
}
]
}
