View Domain

This method is used to view a domain object

Request Parameters

GET /api/clients/v1/domains/{id}/

Headers

• Content-Type: application/json
• Authorization: Bearer $access_token

Path

Parameter	Type	Constraints	Description	Example
id	integer	> 0, required	Domain ID	2

Response Parameters

Examples

200 OK

Domain object

{
  "id": 12,
  "project_id": 1,
  "name": "example.com",
  "type": "delegated",
  "status": "ok",
  "canonical_link": "https://example.com/",
  "redirect_from_80_to_443": true,
  "port": 443,
  "ips": [
    {
      "ip": "192.168.1.1",
      "is_active": true,
      "ttl": 360
    }
  ],
  "sitemap": "https://example.com/sitemap.xml",
  "on_cdn_ns": true,
  "last_cache_refill": "2024-05-15T08:52:49.733Z",
  "last_cache_cleanup": "2024-05-15T08:52:49.733Z"
}

400 Bad Request

Invalid path parameters specified

{
  "id": [
    "A valid integer is required."
  ]
}

401 Unauthorized

Authentication credentials missing or invalid

{
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
    {
    "token_class": "AccessToken",
    "token_type": "access",
    "message": "Token is invalid or expired"
    }
]
}

403 Forbidden

Only project participants can view this domain

{
  "detail": "Only project participants can view this domain"
}

404 Not Found

Domain with this ID not found

{
  "detail": "Not found"
}