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.
IPAddress API
Source: daemon/proto/hostcraft/v1/ip.proto
IPAddressService
Section titled “IPAddressService”IPAddressService manages the server IP pool (the WHM "IP Functions" set): adding and discovering addresses and assigning a dedicated IP to an account or site. Assign and release run as workflows. REST: /api/v1/ips.
| Method | REST route | Permission | Streaming |
|---|---|---|---|
ListIPAddresses |
GET /api/v1/ips |
IPAddressRead |
unary |
AddIPAddress |
POST /api/v1/ips |
IPAddressManage |
unary |
DiscoverIPAddresses |
POST /api/v1/ips/discover |
IPAddressManage |
unary |
GetIPAddress |
GET /api/v1/ips/{address} |
IPAddressRead |
unary |
UpdateIPAddress |
PATCH /api/v1/ips/{address} |
IPAddressManage |
unary |
RemoveIPAddress |
DELETE /api/v1/ips/{address} |
IPAddressManage |
unary |
AssignIPAddress |
POST /api/v1/ips/{address}/assign |
IPAddressAssign |
unary |
ReleaseIPAddress |
POST /api/v1/ips/{address}/release |
IPAddressAssign |
unary |
ListIPAddresses
Section titled “ListIPAddresses”/hostcraft.v1.IPAddressService/ListIPAddresses
- Request: ListIPAddressesRequest
- Response: ListIPAddressesResponse
AddIPAddress
Section titled “AddIPAddress”/hostcraft.v1.IPAddressService/AddIPAddress
- Request: AddIPAddressRequest
- Response: IPAddressResponse
DiscoverIPAddresses
Section titled “DiscoverIPAddresses”/hostcraft.v1.IPAddressService/DiscoverIPAddresses
- Request: DiscoverIPAddressesRequest
- Response: DiscoverIPAddressesResponse
GetIPAddress
Section titled “GetIPAddress”/hostcraft.v1.IPAddressService/GetIPAddress
- Request: GetIPAddressRequest
- Response: IPAddressResponse
UpdateIPAddress
Section titled “UpdateIPAddress”/hostcraft.v1.IPAddressService/UpdateIPAddress
- Request: UpdateIPAddressRequest
- Response: IPAddressResponse
RemoveIPAddress
Section titled “RemoveIPAddress”/hostcraft.v1.IPAddressService/RemoveIPAddress
- Request: RemoveIPAddressRequest
- Response: Empty
AssignIPAddress
Section titled “AssignIPAddress”/hostcraft.v1.IPAddressService/AssignIPAddress
- Request: AssignIPAddressRequest
- Response: IPWorkflowResponse
ReleaseIPAddress
Section titled “ReleaseIPAddress”/hostcraft.v1.IPAddressService/ReleaseIPAddress
- Request: ReleaseIPAddressRequest
- Response: IPWorkflowResponse
Messages
Section titled “Messages”AddIPAddressRequest
Section titled “AddIPAddressRequest”| Field | Type | Number | Description |
|---|---|---|---|
address |
string |
1 | - |
note |
string |
2 | - |
AssignIPAddressRequest
Section titled “AssignIPAddressRequest”| Field | Type | Number | Description |
|---|---|---|---|
address |
string |
1 | - |
account_id |
string |
2 | - |
site_id |
string |
3 | - |
DiscoverIPAddressesRequest
Section titled “DiscoverIPAddressesRequest”No fields.
DiscoverIPAddressesResponse
Section titled “DiscoverIPAddressesResponse”| Field | Type | Number | Description |
|---|---|---|---|
added |
int64 |
1 | - |
Empty is returned by RPCs whose REST route answers with an empty object or 204 No Content.
No fields.
GetIPAddressRequest
Section titled “GetIPAddressRequest”| Field | Type | Number | Description |
|---|---|---|---|
address |
string |
1 | - |
IPAddress
Section titled “IPAddress”| Field | Type | Number | Description |
|---|---|---|---|
address |
string |
1 | - |
family |
int64 |
2 | 4 or 6 |
interface |
string |
3 | - |
bound |
bool |
4 | - |
shared |
bool |
5 | - |
note |
string |
6 | - |
account_id |
string |
7 | - |
site_id |
string |
8 | - |
site_fqdn |
string |
9 | - |
assigned_at |
google.protobuf.Timestamp |
10 | - |
created_at |
google.protobuf.Timestamp |
11 | - |
IPAddressResponse
Section titled “IPAddressResponse”| Field | Type | Number | Description |
|---|---|---|---|
address |
IPAddress |
1 | - |
IPWorkflowResponse
Section titled “IPWorkflowResponse”| Field | Type | Number | Description |
|---|---|---|---|
workflow_id |
string |
1 | - |
ListIPAddressesRequest
Section titled “ListIPAddressesRequest”No fields.
ListIPAddressesResponse
Section titled “ListIPAddressesResponse”| Field | Type | Number | Description |
|---|---|---|---|
addresses |
repeated IPAddress |
1 | - |
ReleaseIPAddressRequest
Section titled “ReleaseIPAddressRequest”| Field | Type | Number | Description |
|---|---|---|---|
address |
string |
1 | - |
RemoveIPAddressRequest
Section titled “RemoveIPAddressRequest”| Field | Type | Number | Description |
|---|---|---|---|
address |
string |
1 | - |
UpdateIPAddressRequest
Section titled “UpdateIPAddressRequest”| Field | Type | Number | Description |
|---|---|---|---|
address |
string |
1 | - |
note |
string |
2 | - |