Delphi (DLL) / Support API / Check Host Mapping Validity
Back to Collection Items
var
begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');CkJsonObject_UpdateString(queryParams,'host_mapping','<string>');CkJsonObject_UpdateString(queryParams,'subdomain','<string>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);strVal := CkJsonObject__stringOf(jResp,'expected_cnames[i]');i := i + 1;
Curl Command
curl -u login:password -G -d "host_mapping=%3Cstring%3E"
-d "subdomain=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/brands/check_host_mapping
Postman Collection Item JSON
{
"name": "Check Host Mapping Validity",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/brands/check_host_mapping?host_mapping=<string>&subdomain=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands",
"check_host_mapping"
],
"query": [
{
"key": "host_mapping",
"value": "<string>",
"description": "(Required) The hostmapping to a brand, if any (only admins view this key)"
},
{
"key": "subdomain",
"value": "<string>",
"description": "(Required) Subdomain for a given Zendesk account address"
}
]
},
"description": "Returns a JSON object determining whether a host mapping is valid for a given subdomain.\n\n#### Allowed for\n\n* Admins"
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/brands/check_host_mapping?host_mapping=<string>&subdomain=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands",
"check_host_mapping"
],
"query": [
{
"key": "host_mapping",
"value": "<string>",
"description": "(Required) The hostmapping to a brand, if any (only admins view this key)"
},
{
"key": "subdomain",
"value": "<string>",
"description": "(Required) Subdomain for a given Zendesk account address"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"cname\": \"<string>\",\n \"expected_cnames\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_valid\": \"<boolean>\",\n \"reason\": \"<string>\"\n}"
}
]
}