Organization API: Customer Portal: Allocations
The 8 Organization API operations for allocations.
Part of Customer Portal.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations |
List allocations |
| POST | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations |
Create allocation |
| GET | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/available-ports |
Available ports |
| GET | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/request |
Get port request |
| POST | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/request |
Ask staff for an extra port on a free server whose brand requires it |
| DELETE | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/{allocation_id} |
Delete allocation |
| POST | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/{allocation_id}/primary |
Make one of the server's ports the one players type |
| POST | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/{allocation_id}/publish-port |
Publish a port on the game's default port of the attached floating IP |
List allocations
Section titled List allocationsGET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations
The server's ports, where they publish, the node-range limit, the rules
for ports on its dedicated IP (dedicated_ip, when one is attached) and
which default port its players type (game).
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Create allocation
Section titled Create allocationPOST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Request body
Section titled Request bodyapplication/json
| Field | Type | Required |
|---|---|---|
port |
integer or null | no |
notes |
string or null | no |
on_dedicated_ip |
boolean | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Available ports
Section titled Available portsGET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/available-ports
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
uuid |
path | string | yes | |
org_slug |
path | string | yes | |
limit |
query | integer | no | Default: 50. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Get port request
Section titled Get port requestGET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/request
Whether this server's extra ports go through a ticket, and the open request if there is one, so the panel can say "requested" rather than offer the form twice.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Ask staff for an extra port on a free server whose brand requires it
Section titled Ask staff for an extra port on a free server whose brand requires itPOST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/request
Ask staff for an extra port on a free server whose brand requires it.
Opens one ticket tagged port-request against the order; a second
request while one is open is answered with the first. Refused with 403
when the brand does not require requests, because then the customer can
add the port themselves and the panel should not have offered this.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
note |
string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Delete allocation
Section titled Delete allocationDELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/{allocation_id}
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
allocation_id |
path | integer | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Make one of the server's ports the one players type
Section titled Make one of the server's ports the one players typePOST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/{allocation_id}/primary
Make one of the server's ports the one players type.
On a dedicated IP this is how the default port is chosen: the row on 25565
(or 19132) becomes primary, Wings hands it to the process as SERVER_PORT,
the brand hostname's route follows, and a running server restarts onto it.
The publish block says what happened.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
allocation_id |
path | integer | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Publish a port on the game's default port of the attached floating IP
Section titled Publish a port on the game's default port of the attached floating IPPOST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/allocations/{allocation_id}/publish-port
Publish a port on the game's default port of the attached floating IP.
The whole point of a dedicated address is that players type it and nothing
else, so this is what makes 25565 (or 19132 for Bedrock) answer on
the float. Wings rebinds and a running server restarts, exactly as on attach.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
allocation_id |
path | integer | yes |
org_slug |
path | string | yes |
Request body
Section titled Request bodyapplication/json
| Field | Type | Required |
|---|---|---|
port |
integer or null | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |