IP Groups
List IP Groups
GET /group
List of IP Groups
Response 200: A List of IP Groups
| Field | Type | Description |
|---|---|---|
billing_id |
string | |
entities |
object | |
entities.count |
integer | |
entitiesCount |
integer | |
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
name |
string | |
pxe_dhcp_server |
object | |
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
pxe_dhcp_server.name |
string | |
reserved |
boolean | |
servers |
object | |
servers.count |
integer | |
servers.inventory |
integer |
Create IP Group
POST /group
Create a new IP Group
Request body
| Field | Type | Required | Description |
|---|---|---|---|
billing_id |
string | ||
entities |
object | ||
entities.count |
integer | ||
entitiesCount |
integer | ||
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
name |
string | ||
pxe_dhcp_server |
object | ||
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
pxe_dhcp_server.name |
string | ||
reserved |
boolean | ||
servers |
object | ||
servers.count |
integer | ||
servers.inventory |
integer |
Response 200: An IP Group
| Field | Type | Description |
|---|---|---|
billing_id |
string | |
entities |
object | |
entities.count |
integer | |
entitiesCount |
integer | |
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
name |
string | |
pxe_dhcp_server |
object | |
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
pxe_dhcp_server.name |
string | |
reserved |
boolean | |
servers |
object | |
servers.count |
integer | |
servers.inventory |
integer |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
billing_id |
string | ||
entities |
object | ||
entities.count |
integer | ||
entitiesCount |
integer | ||
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
name |
string | ||
pxe_dhcp_server |
object | ||
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
pxe_dhcp_server.name |
string | ||
reserved |
boolean | ||
servers |
object | ||
servers.count |
integer | ||
servers.inventory |
integer |
Response 422: Unprocessable Entity
Delete IP Group
DELETE /group/{group_id}
Delete an IP Group
Response 200: IP Group deleted successfully
Response 404: Item not Found
View IP Group
GET /group/{group_id}
An IP Group
Response 200: An IP Group
| Field | Type | Description |
|---|---|---|
billing_id |
string | |
entities |
object | |
entities.count |
integer | |
entitiesCount |
integer | |
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
name |
string | |
pxe_dhcp_server |
object | |
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
pxe_dhcp_server.name |
string | |
reserved |
boolean | |
servers |
object | |
servers.count |
integer | |
servers.inventory |
integer |
Edit IP Group
PATCH /group/{group_id}
Request body
| Field | Type | Required | Description |
|---|---|---|---|
billing_id |
string | ||
entities |
object | ||
entities.count |
integer | ||
entitiesCount |
integer | ||
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
name |
string | ||
pxe_dhcp_server |
object | ||
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
pxe_dhcp_server.name |
string | ||
reserved |
boolean | ||
servers |
object | ||
servers.count |
integer | ||
servers.inventory |
integer |
Response 200: An IP Group
| Field | Type | Description |
|---|---|---|
billing_id |
string | |
entities |
object | |
entities.count |
integer | |
entitiesCount |
integer | |
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
name |
string | |
pxe_dhcp_server |
object | |
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. |
pxe_dhcp_server.name |
string | |
reserved |
boolean | |
servers |
object | |
servers.count |
integer | |
servers.inventory |
integer |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
billing_id |
string | ||
entities |
object | ||
entities.count |
integer | ||
entitiesCount |
integer | ||
id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
name |
string | ||
pxe_dhcp_server |
object | ||
pxe_dhcp_server.id |
integer | VirtlixCP-specific unique identifier used for URLs, etc. | |
pxe_dhcp_server.name |
string | ||
reserved |
boolean | ||
servers |
object | ||
servers.count |
integer | ||
servers.inventory |
integer |
Response 422: Unprocessable Entity