GET /api/domains
List of domains

GET /api/subnets/:subnet_id/domains
List of domains per subnet

GET /api/locations/:location_id/domains
List of domains per location

GET /api/organizations/:organization_id/domains
List of domains per organization

Examples

GET /api/domains
200
{
  "total": 4,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "location_id=373111740",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "fullname": "somewhare that is never used",
      "created_at": "2024-02-22 15:54:00 UTC",
      "updated_at": "2024-02-22 15:54:00 UTC",
      "id": 759776763,
      "name": "unused.net",
      "dns_id": 113629430,
      "dns": {
        "name": "DNS Proxy",
        "id": 113629430,
        "url": "http://else.where:45671"
      }
    }
  ]
}

Params

Param name Description
subnet_id
optional

ID of subnet

Validations:

  • String
location_id
optional

Scope by locations

Validations:

  • Integer
organization_id
optional

Scope by organizations

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
fullname string
id integer
location string
location_id integer
name string
organization string
organization_id integer
params string