Chilkat Online Tools

Python / Support API / Check Host Mapping Validity

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

queryParams = chilkat2.JsonObject()
queryParams.UpdateString("host_mapping","<string>")
queryParams.UpdateString("subdomain","<string>")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/brands/check_host_mapping",queryParams)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "cname": "<string>",
#   "expected_cnames": [
#     "<string>",
#     "<string>"
#   ],
#   "is_valid": "<boolean>",
#   "reason": "<string>"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

cname = jResp.StringOf("cname")
is_valid = jResp.StringOf("is_valid")
reason = jResp.StringOf("reason")
i = 0
count_i = jResp.SizeOfArray("expected_cnames")
while i < count_i :
    jResp.I = i
    strVal = jResp.StringOf("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}"
    }
  ]
}