Create DNS Domain record

Create a new DNS Domain record within a service.

POST
https://portal.onyx.io/api/v2/dns_domains/{dns_domain}/records

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

dns_domain Required

DNS Domain Lookup None

record_name Required

The name of the DNS Domain record

String None

type Required

The type of the DNS Domain record

String None

ttl Required

The TTL value of the DNS Domain record

Integer None

record_fields

DNSDomainRecordArguments None

Potential Errors

The following errors may occur during this request.

Details HTTP status

dns_domain_not_found

No DNS Domain was found matching any of the criteria provided in the arguments

404 Not Found

dns_service_error

There was an error with your request

500 Internal Server Error

invalid_record_field_argument

One or more fields are invalid or empty

400 Bad Request

invalid_record_type

The provided record type is not valid

400 Bad Request

Returned Object

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

{
    record_created: Boolean
}