POST /api/domains
Create a domain

The fullname field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter

Examples

POST /api/domains
{
  "organization_id": 447626448,
  "domain": {
    "name": "example586.com",
    "location_ids": [
      447626450
    ]
  }
}
201
{
  "fullname": null,
  "created_at": "2021-11-26 08:27:37 UTC",
  "updated_at": "2021-11-26 08:27:37 UTC",
  "id": 759776773,
  "name": "example586.com",
  "dns_id": null,
  "dns": null,
  "subnets": [],
  "interfaces": [],
  "parameters": [],
  "locations": [
    {
      "id": 447626450,
      "name": "loc220",
      "title": "loc220",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626448,
      "name": "org176",
      "title": "org176",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
domain
required

Validations:

  • Must be a Hash
domain[name]
required

The full DNS domain name

Validations:

  • Must be a String
domain[fullname]
optional , nil allowed

Description of the domain

Validations:

  • Must be a String
domain[dns_id]
optional , nil allowed

DNS proxy ID to use within this domain

Validations:

  • Must be a number.
domain[domain_parameters_attributes]
optional , nil allowed

Array of parameters (name, value)

Validations:

  • Must be an array of any type
domain[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
domain[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type