Skip to main content
POST
/
v1
/
api
/
get_domain_uuid
/
curl -X POST https://api.hookpulse.io/v1/api/get_domain_uuid/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_name": "{{domain_name}}",
    "protocol_type": "{{protocol_type}}"
  }'

{
  "success": true,
  "domain_uuid": "{{domain_uuid}}"
}
Retrieve the UUID for a specific domain by providing the domain name and protocol type.

​
Example request

curl -X POST https://api.hookpulse.io/v1/api/get_domain_uuid/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_name": "{{domain_name}}",
    "protocol_type": "{{protocol_type}}"
  }'

​
Request body

FieldTypeRequiredDescription
domain_namestringYesDomain name to look up (e.g., “api.hookpulse.io”)
protocol_typestringYesProtocol type for the domain (e.g., “https”, “http”)

​
Example response

{
  "success": true,
  "domain_uuid": "{{domain_uuid}}"
}

​
Response fields

FieldTypeDescription
successbooleanIndicates if the request was successful
domain_uuidstringUnique identifier for the domain

Authorizations

​
x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

​
x-brand-uuid
string
header
required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Body

application/json

Domain lookup request

​
domain_name
string
required

Domain name to look up

​
protocol_type
string
required

Protocol type for the domain (e.g., 'https', 'http')

Response

Successful response

​
success
boolean

Indicates if the request was successful

​
domain_uuid
string

Unique identifier for the domain