Core API
Domain Zones
API reference for Domain Zones (core.apoxy.dev/v1alpha3)
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 |
|---|---|---|
nameservers | string[] | Nameservers to use for this domain zone. If not specified, defaults to Apoxy's nameservers. |
registrationConfig | RegistrationConfig | RegistrationConfig contains configuration for domain registration. |
Response
200: OK201: Created202: 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 |
|---|---|---|
nameservers | string[] | Nameservers to use for this domain zone. If not specified, defaults to Apoxy's nameservers. |
registrationConfig | RegistrationConfig | RegistrationConfig contains configuration for domain registration. |
Response
200: OK201: Created
Update Domain Zone
PATCH/apis/core.apoxy.dev/v1alpha3/domainzones/{name}
Partially update the specified DomainZone
Response
200: OK201: Created
Delete Domain Zone
DELETE/apis/core.apoxy.dev/v1alpha3/domainzones/{name}
Delete a DomainZone
Response
200: OK202: Accepted
Schema Reference
RegistrationConfig
| Field | Type | Description |
|---|---|---|
autoRenew | boolean | AutoRenew indicates whether the domain should be automatically renewed. |
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. |