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.
Domain API
Source: daemon/proto/hostcraft/v1/domain.proto
DomainService
Section titled “DomainService”DomainService manages the domains attached to accounts. REST: /api/v1/domains.
| Method | REST route | Permission | Streaming |
|---|---|---|---|
CreateDomain |
POST /api/v1/domains |
DomainCreate |
unary |
ListDomains |
GET /api/v1/domains |
DomainRead |
unary |
GetDomain |
GET /api/v1/domains/{id} |
DomainRead |
unary |
DeleteDomain |
DELETE /api/v1/domains/{id} |
DomainDelete |
unary |
CreateDomain
Section titled “CreateDomain”/hostcraft.v1.DomainService/CreateDomain
- Request: CreateDomainRequest
- Response: CreateDomainResponse
ListDomains
Section titled “ListDomains”/hostcraft.v1.DomainService/ListDomains
- Request: ListDomainsRequest
- Response: ListDomainsResponse
GetDomain
Section titled “GetDomain”/hostcraft.v1.DomainService/GetDomain
- Request: GetDomainRequest
- Response: Domain
DeleteDomain
Section titled “DeleteDomain”DeleteDomain needs a freshly re-authenticated session over REST; over gRPC it is available to the local root principal only.
/hostcraft.v1.DomainService/DeleteDomain
- Request: DeleteDomainRequest
- Response: WorkflowAccepted
Messages
Section titled “Messages”CreateDomainRequest
Section titled “CreateDomainRequest”| Field | Type | Number | Description |
|---|---|---|---|
account_id |
string |
1 | defaults to the caller's account |
fqdn |
string |
2 | - |
kind |
string |
3 | primary (default) | addon | parked |
aliases_for |
string |
4 | parked: the domain id this one aliases |
document_root |
string |
5 | - |
dns_managed |
bool |
6 | - |
CreateDomainResponse
Section titled “CreateDomainResponse”| Field | Type | Number | Description |
|---|---|---|---|
domain |
Domain |
1 | - |
workflow_id |
string |
2 | - |
DeleteDomainRequest
Section titled “DeleteDomainRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
keep_files |
bool |
2 | - |
Domain
Section titled “Domain”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
account_id |
string |
2 | - |
fqdn |
string |
3 | - |
kind |
string |
4 | primary | addon | parked |
document_root |
string |
5 | - |
dns_managed |
bool |
6 | - |
ssl_enabled |
bool |
7 | - |
created_at |
google.protobuf.Timestamp |
8 | - |
GetDomainRequest
Section titled “GetDomainRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
ListDomainsRequest
Section titled “ListDomainsRequest”| Field | Type | Number | Description |
|---|---|---|---|
account_id |
string |
1 | - |
ListDomainsResponse
Section titled “ListDomainsResponse”| Field | Type | Number | Description |
|---|---|---|---|
domains |
repeated Domain |
1 | - |
WorkflowAccepted
Section titled “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 | - |