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()
http.SetRequestHeader("Accept","application/json")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/org",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "orgs": [
# {
# "billing": {
# "type": "parent_billing"
# },
# "created": "2019-09-26T17:28:28Z",
# "description": "some description",
# "name": "New child org",
# "public_id": "abcdef12345",
# "settings": {
# "private_widget_share": false,
# "saml": {
# "enabled": false
# },
# "saml_autocreate_access_role": "ro",
# "saml_autocreate_users_domains": {
# "domains": [
# "example.com",
# "example.com"
# ],
# "enabled": false
# },
# "saml_can_be_enabled": false,
# "saml_idp_endpoint": "https://my.saml.endpoint",
# "saml_idp_initiated_login": {
# "enabled": false
# },
# "saml_idp_metadata_uploaded": false,
# "saml_login_url": "https://my.saml.login.url",
# "saml_strict_mode": {
# "enabled": false
# }
# },
# "subscription": {
# "type": "pro"
# },
# "trial": false
# },
# {
# "billing": {
# "type": "parent_billing"
# },
# "created": "2019-09-26T17:28:28Z",
# "description": "some description",
# "name": "New child org",
# "public_id": "abcdef12345",
# "settings": {
# "private_widget_share": false,
# "saml": {
# "enabled": false
# },
# "saml_autocreate_access_role": "ro",
# "saml_autocreate_users_domains": {
# "domains": [
# "example.com",
# "example.com"
# ],
# "enabled": false
# },
# "saml_can_be_enabled": false,
# "saml_idp_endpoint": "https://my.saml.endpoint",
# "saml_idp_initiated_login": {
# "enabled": false
# },
# "saml_idp_metadata_uploaded": false,
# "saml_login_url": "https://my.saml.login.url",
# "saml_strict_mode": {
# "enabled": false
# }
# },
# "subscription": {
# "type": "pro"
# },
# "trial": false
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
count_i = jResp.SizeOfArray("orgs")
while i < count_i
jResp.put_I(i)
v_Type = jResp.stringOf("orgs[i].billing.type")
created = jResp.stringOf("orgs[i].created")
description = jResp.stringOf("orgs[i].description")
name = jResp.stringOf("orgs[i].name")
public_id = jResp.stringOf("orgs[i].public_id")
Private_widget_share = jResp.BoolOf("orgs[i].settings.private_widget_share")
Enabled = jResp.BoolOf("orgs[i].settings.saml.enabled")
Saml_autocreate_access_role = jResp.stringOf("orgs[i].settings.saml_autocreate_access_role")
Saml_autocreate_users_domainsEnabled = jResp.BoolOf("orgs[i].settings.saml_autocreate_users_domains.enabled")
Saml_can_be_enabled = jResp.BoolOf("orgs[i].settings.saml_can_be_enabled")
Saml_idp_endpoint = jResp.stringOf("orgs[i].settings.saml_idp_endpoint")
Saml_idp_initiated_loginEnabled = jResp.BoolOf("orgs[i].settings.saml_idp_initiated_login.enabled")
Saml_idp_metadata_uploaded = jResp.BoolOf("orgs[i].settings.saml_idp_metadata_uploaded")
Saml_login_url = jResp.stringOf("orgs[i].settings.saml_login_url")
Saml_strict_modeEnabled = jResp.BoolOf("orgs[i].settings.saml_strict_mode.enabled")
subscriptionType = jResp.stringOf("orgs[i].subscription.type")
trial = jResp.BoolOf("orgs[i].trial")
j = 0
count_j = jResp.SizeOfArray("orgs[i].settings.saml_autocreate_users_domains.domains")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("orgs[i].settings.saml_autocreate_users_domains.domains[j]")
j = j + 1
end
i = i + 1
end
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/org
Postman Collection Item JSON
{
"name": "List your managed organizations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
},
"description": "This endpoint returns data on your top-level organization."
},
"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/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"orgs\": [\n {\n \"billing\": {\n \"type\": \"parent_billing\"\n },\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"subscription\": {\n \"type\": \"pro\"\n },\n \"trial\": false\n },\n {\n \"billing\": {\n \"type\": \"parent_billing\"\n },\n \"created\": \"2019-09-26T17:28:28Z\",\n \"description\": \"some description\",\n \"name\": \"New child org\",\n \"public_id\": \"abcdef12345\",\n \"settings\": {\n \"private_widget_share\": false,\n \"saml\": {\n \"enabled\": false\n },\n \"saml_autocreate_access_role\": \"ro\",\n \"saml_autocreate_users_domains\": {\n \"domains\": [\n \"example.com\",\n \"example.com\"\n ],\n \"enabled\": false\n },\n \"saml_can_be_enabled\": false,\n \"saml_idp_endpoint\": \"https://my.saml.endpoint\",\n \"saml_idp_initiated_login\": {\n \"enabled\": false\n },\n \"saml_idp_metadata_uploaded\": false,\n \"saml_login_url\": \"https://my.saml.login.url\",\n \"saml_strict_mode\": {\n \"enabled\": false\n }\n },\n \"subscription\": {\n \"type\": \"pro\"\n },\n \"trial\": false\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/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\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/v1/org",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"org"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
