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/locations/447626442/domains
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "fullname": "example5.com",
      "created_at": "2018-11-16 10:02:09 UTC",
      "updated_at": "2018-11-16 10:02:09 UTC",
      "id": 759776764,
      "name": "example5.com",
      "dns_id": null,
      "dns": null
    },
    {
      "fullname": "example6.com",
      "created_at": "2018-11-16 10:02:09 UTC",
      "updated_at": "2018-11-16 10:02:09 UTC",
      "id": 759776765,
      "name": "example6.com",
      "dns_id": null,
      "dns": null
    }
  ]
}

Params

Param name Description
subnet_id
optional

ID of subnet

Validations:

  • Must be a String
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

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

Validations:

  • Must be a 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