Skip to content

Get a hostname

GET
/api/organizations/{organizationId}/hostnames/{id}

Returns a single hostname in the organization by id. This is the canonical IRI route for the resource, so it resolves whether the hostname is zone-owned or redirect-owned.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

organizationId*

Organization identifier

Type
string
Required
id*

hostname identifier

Type
string
Required

Responses

hostname resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "9f1b2c3d-4e5f-6789-abcd-ef0123456789",
  
"domain": "https://example.com/",
  
"zone": "https://example.com/",
  
"redirect": "https://example.com/",
  
"name": "www.example.com",
  
"cnameTarget": "string",
  
"cdnEnabled": false,
  
"dnsTargetStatus": "pending",
  
"dnsObservedValue": "string",
  
"dnsLastCheckedAt": "2026-07-01T12:00:00+00:00",
  
"createdAt": "2026-07-01T12:00:00+00:00",
  
"updatedAt": "2026-07-01T12:00:00+00:00",
  
"sharedCertificate": false
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI