Pre-release. HostCraft is in testing and not yet for sale. These docs describe the current build and may change. Join the waitlist to hear when it launches.

DNS API

Source: daemon/proto/hostcraft/v1/dns.proto

DNSService

DNSService manages PowerDNS zones and records. REST: /api/v1/dns/zones.

Method	REST route	Permission	Streaming
`ListZones`	`GET /api/v1/dns/zones`	`DNSZoneRead`	unary
`CreateZone`	`POST /api/v1/dns/zones`	`DNSZoneCreate`	unary
`GetZone`	`GET /api/v1/dns/zones/{id}`	`DNSZoneRead`	unary
`DeleteZone`	`DELETE /api/v1/dns/zones/{id}`	`DNSZoneDelete`	unary
`ListRecords`	`GET /api/v1/dns/zones/{zone_id}/records`	`DNSRecordRead`	unary
`CreateRecord`	`POST /api/v1/dns/zones/{zone_id}/records`	`DNSRecordCreate`	unary
`UpdateRecord`	`PATCH /api/v1/dns/zones/{zone_id}/records/{id}`	`DNSRecordUpdate`	unary
`DeleteRecord`	`DELETE /api/v1/dns/zones/{zone_id}/records/{id}`	`DNSRecordDelete`	unary
`BulkUpdateRecords`	`POST /api/v1/dns/zones/{zone_id}/records/bulk`	`DNSRecordBulk`	unary
`EnableDNSSEC`	`POST /api/v1/dns/zones/{zone_id}/dnssec/enable`	`DNSDNSSECManage`	unary
`DisableDNSSEC`	`POST /api/v1/dns/zones/{zone_id}/dnssec/disable`	`DNSDNSSECManage`	unary
`GetDNSSEC`	`GET /api/v1/dns/zones/{zone_id}/dnssec`	`DNSDNSSECRead`	unary
`GetNameservers`	`GET /api/v1/dns/zones/{zone_id}/nameservers`	`DNSZoneRead`	unary
`CheckZone`	`POST /api/v1/dns/zones/{zone_id}/check`	`DNSZoneCheck`	unary
`ImportZone`	`POST /api/v1/dns/zones/{zone_id}/import`	`DNSZoneImport`	unary
`ExportZone`	`GET /api/v1/dns/zones/{zone_id}/export`	`DNSZoneExport`	unary

ListZones

/hostcraft.v1.DNSService/ListZones

Request: ListZonesRequest
Response: ListZonesResponse

CreateZone

/hostcraft.v1.DNSService/CreateZone

Request: CreateZoneRequest
Response: CreateZoneResponse

GetZone

/hostcraft.v1.DNSService/GetZone

Request: GetZoneRequest
Response: GetZoneResponse

DeleteZone

/hostcraft.v1.DNSService/DeleteZone

Request: DeleteZoneRequest
Response: WorkflowAccepted

ListRecords

/hostcraft.v1.DNSService/ListRecords

Request: ListRecordsRequest
Response: ListRecordsResponse

CreateRecord

/hostcraft.v1.DNSService/CreateRecord

Request: CreateRecordRequest
Response: DNSRecord

UpdateRecord

/hostcraft.v1.DNSService/UpdateRecord

Request: UpdateRecordRequest
Response: DNSRecord

DeleteRecord

/hostcraft.v1.DNSService/DeleteRecord

Request: DeleteRecordRequest
Response: Empty

BulkUpdateRecords

/hostcraft.v1.DNSService/BulkUpdateRecords

Request: BulkUpdateRecordsRequest
Response: BulkUpdateRecordsResponse

EnableDNSSEC

/hostcraft.v1.DNSService/EnableDNSSEC

Request: EnableDNSSECRequest
Response: WorkflowAccepted

DisableDNSSEC

/hostcraft.v1.DNSService/DisableDNSSEC

Request: DisableDNSSECRequest
Response: Empty

GetDNSSEC

/hostcraft.v1.DNSService/GetDNSSEC

Request: GetDNSSECRequest
Response: DNSSECInfo

GetNameservers

/hostcraft.v1.DNSService/GetNameservers

Request: GetNameserversRequest
Response: GetNameserversResponse

CheckZone

/hostcraft.v1.DNSService/CheckZone

Request: CheckZoneRequest
Response: CheckZoneResponse

ImportZone

/hostcraft.v1.DNSService/ImportZone

Request: ImportZoneRequest
Response: ImportZoneResponse

ExportZone

ExportZone returns the zone in BIND format.

/hostcraft.v1.DNSService/ExportZone

Request: ExportZoneRequest
Response: ExportZoneResponse

Messages

BulkUpdateRecordsRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-
`records`	`repeated DNSRecord`	2	records with an id are updated, without are created
`delete_ids`	`repeated string`	3	-

BulkUpdateRecordsResponse

Field	Type	Number	Description
`created`	`int64`	1	-
`updated`	`int64`	2	-
`deleted`	`int64`	3	-

CheckZoneRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-

CheckZoneResponse

Field	Type	Number	Description
`valid`	`bool`	1	-
`warnings`	`repeated string`	2	-
`errors`	`repeated string`	3	-

CreateRecordRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-
`name`	`string`	2	-
`type`	`string`	3	-
`content`	`string`	4	-
`ttl`	`uint32`	5	-
`priority`	`uint32`	6	-

CreateZoneRequest

Field	Type	Number	Description
`account_id`	`string`	1	-
`fqdn`	`string`	2	-
`type`	`string`	3	-
`default_a`	`string`	4	IPv4 for the default A/www records

CreateZoneResponse

Field	Type	Number	Description
`zone`	`DNSZone`	1	-
`workflow_id`	`string`	2	-

DNSRecord

Field	Type	Number	Description
`id`	`string`	1	-
`zone_id`	`string`	2	-
`name`	`string`	3	-
`type`	`string`	4	-
`content`	`string`	5	-
`ttl`	`uint32`	6	-
`priority`	`uint32`	7	-
`disabled`	`bool`	8	-

DNSSECInfo

Field	Type	Number	Description
`ds_records`	`repeated string`	1	-
`dnskey_records`	`repeated string`	2	-

DNSZone

Field	Type	Number	Description
`id`	`string`	1	-
`account_id`	`string`	2	-
`fqdn`	`string`	3	-
`type`	`string`	4	master \| slave \| native
`soa_serial`	`uint32`	5	-
`dnssec_enabled`	`bool`	6	-
`created_at`	`google.protobuf.Timestamp`	7	-
`updated_at`	`google.protobuf.Timestamp`	8	-

DeleteRecordRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-
`id`	`string`	2	-

DeleteZoneRequest

Field	Type	Number	Description
`id`	`string`	1	-

DisableDNSSECRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-

Empty

Empty is returned by RPCs whose REST route answers with an empty object or 204 No Content.

No fields.

EnableDNSSECRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-

ExportZoneRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-

ExportZoneResponse

Field	Type	Number	Description
`bind_zone`	`string`	1	-

GetDNSSECRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-

GetNameserversRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-

GetNameserversResponse

Field	Type	Number	Description
`nameservers`	`repeated string`	1	-

GetZoneRequest

Field	Type	Number	Description
`id`	`string`	1	-

GetZoneResponse

Field	Type	Number	Description
`zone`	`DNSZone`	1	-
`records`	`repeated DNSRecord`	2	-

ImportZoneRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-
`bind_zone`	`string`	2	-
`replace`	`bool`	3	-

ImportZoneResponse

Field	Type	Number	Description
`records_imported`	`int64`	1	-

ListRecordsRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-

ListRecordsResponse

Field	Type	Number	Description
`records`	`repeated DNSRecord`	1	-

ListZonesRequest

Field	Type	Number	Description
`account_id`	`string`	1	-

ListZonesResponse

Field	Type	Number	Description
`zones`	`repeated DNSZone`	1	-

UpdateRecordRequest

Field	Type	Number	Description
`zone_id`	`string`	1	-
`id`	`string`	2	-
`content`	`optional string`	3	-
`ttl`	`optional uint32`	4	-
`priority`	`optional uint32`	5	-
`disabled`	`optional bool`	6	-

WorkflowAccepted

WorkflowAccepted is the body of every 202 response that only starts a workflow saga. Follow progress with WorkflowService.StreamWorkflow.

Field	Type	Number	Description
`workflow_id`	`string`	1	-