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
{
  "domain": {
    "name": "doma.in",
    "dns_id": 281110243
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "dns_id": [
        "Invalid smart-proxy id"
      ]
    },
    "full_messages": [
      "Dns Invalid smart-proxy id"
    ]
  }
}

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
domain
required

Validations:

  • Hash
domain[name]
required

The full DNS domain name

Validations:

  • String
domain[fullname]
optional , nil allowed

Description of the domain

Validations:

  • 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