DomainZone

API Group: core.apoxy.dev/v1alpha3

Operations

List Domain Zones

GET/apis/core.apoxy.dev/v1alpha3/domainzones

List DomainZone

Response

200: OK

Create Domain Zone

POST/apis/core.apoxy.dev/v1alpha3/domainzones

Create a DomainZone

Request Body

Spec fields (DomainZoneSpec):

Field	Type	Description
`registrationConfig`	RegistrationConfig	RegistrationConfig contains configuration for domain registration.

Response

200: OK
201: Created
202: Accepted

Delete All Domain Zones

DELETE/apis/core.apoxy.dev/v1alpha3/domainzones

Delete collection of DomainZone

Response

200: OK

Get Domain Zone

GET/apis/core.apoxy.dev/v1alpha3/domainzones/{name}

Get the specified DomainZone

Response

200: OK

Replace Domain Zone

PUT/apis/core.apoxy.dev/v1alpha3/domainzones/{name}

Replace the specified DomainZone

Request Body

Spec fields (DomainZoneSpec):

Field	Type	Description
`registrationConfig`	RegistrationConfig	RegistrationConfig contains configuration for domain registration.

Response

200: OK
201: Created

Update Domain Zone

PATCH/apis/core.apoxy.dev/v1alpha3/domainzones/{name}

Partially update the specified DomainZone

Response

200: OK
201: Created

Delete Domain Zone

DELETE/apis/core.apoxy.dev/v1alpha3/domainzones/{name}

Delete a DomainZone. Deleting a zone also deletes the DomainRecords in it, and Apoxy nameservers stop serving the zone.

A zone that Apoxy registered for you keeps its registration until it expires. To release such a zone before it expires, set spec.registrationConfig.autoRenew to false and then delete the zone. The domain stays registered to you until the end of the paid term and is not renewed.

Response

200: OK
202: Accepted

Schema Reference

NameserverStatus

Apoxy writes status.nameservers. You cannot change it.

Field	Type	Description
`required`	string[]	Nameservers that the delegation of the zone must use. Set these names at your registrar. Apoxy sets this list one time. It changes only when Apoxy moves the zone to different nameservers, and Apoxy tells you before such a move.
`current`	string[]	Nameservers that the delegation of the zone had at the last check.
`sets`	string[]	Identifiers of the Apoxy nameserver groups that serve the zone. Apoxy manages this list.

RegistrationConfig

Field	Type	Description
`autoRenew`	boolean	AutoRenew indicates whether the domain should be automatically renewed. A registered zone with `autoRenew: false` can be deleted before it expires.
`registrant`	Registrant	Registrant contains the registrant contact information.
`registrationPeriodYears`	integer (int32)	RegistrationPeriodYears is the number of years to register the domain for.

Registrant

Field	Type	Description
`address`	Address	Address of the registrant.
`email`	string	Email of the registrant.
`firstName`	string	FirstName of the registrant.
`lastName`	string	LastName of the registrant.
`organization`	string	Organization of the registrant.
`phone`	string	Phone number of the registrant.

Address

Field	Type	Description
`addressLine1`	string	Address line 1.
`addressLine2`	string	Address line 2.
`city`	string	City.
`country`	string	Country code (ISO 3166-1 alpha-2).
`postalCode`	string	PostalCode or ZIP code.
`stateProvince`	string	State or province.