GET /api/domains/:id
Show a domain

Examples

GET /api/domains/759776764-example362-com
200
{
  "fullname": "example362.com",
  "created_at": "2024-02-22 15:54:02 UTC",
  "updated_at": "2024-02-22 15:54:02 UTC",
  "id": 759776764,
  "name": "example362.com",
  "dns_id": null,
  "dns": null,
  "subnets": [],
  "interfaces": [],
  "parameters": [
    {
      "priority": 30,
      "created_at": "2024-02-22 15:54:02 UTC",
      "updated_at": "2024-02-22 15:54:02 UTC",
      "id": 767575239,
      "name": "parameter15",
      "parameter_type": "string",
      "associated_type": "domain",
      "hidden_value?": false,
      "value": "parameter value 15"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Numerical ID or domain name

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0.