API Reference

Onyx Core API

Resources & Endpoints

Create DNS Domain

Create a new DNS Domain within a service.

POST
https://portal.onyx.io/api/v2/dns_domains

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

name Required

The name for the new site

 String None

Potential Errors

The following errors may occur during this request.

Details HTTP status

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    dns_domain: DNSDomain {
        id: Integer?
        name: String
        service_id: Integer
    }
}