Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Deliver the admitted host shape the engine composes desired state from

Only the Athena platform’s own keys for this event may call this, as part of provisioning its host. An organizer API key is refused with 403.

PUT/api/admin/host/allocation
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
allocationOperationIdstringrequired
min length 1 · max length 64
hostImageVersionstringrequired
min length 1 · max length 64
addressPlanstringrequired
networkProfilestringrequired
min length 1 · max length 64
teamLimitsobjectrequired
Show properties
cpuintegerrequired
max 9007199254740991
memoryMibintegerrequired
max 9007199254740991
diskGibintegerrequired
max 9007199254740991
pidsintegerrequired
max 9007199254740991
admittedTeamCountintegerrequired
max 9007199254740991
maxAdmittedTeamsintegerrequired
max 256
egressAllowlistobject[]required
max items 32
Show properties
Array of object
versionnumberrequired
cidrstringrequired
portintegerrequired
min 1 · max 65535
protocolstringrequired
Allowed:tcpudp
packetsPerSecondintegerrequired
min 1 · max 10000
burstPacketsintegerrequired
min 1 · max 100000
serviceInventoryRevisionstringrequired
matches ^[0-9a-f]{64}$
Responses
200

Success

allocationOperationIdstringrequired
deliveredbooleanrequired
401

Unauthorized

errorstringrequired
403

Response for status 403

errorstringrequired
409

Response for status 409

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X PUT '/api/admin/host/allocation' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "allocationOperationId": "string",
  "hostImageVersion": "string",
  "addressPlan": "athena-ipv4-v1",
  "networkProfile": "string",
  "teamLimits": {
    "cpu": 1,
    "memoryMib": 1,
    "diskGib": 1,
    "pids": 1
  },
  "admittedTeamCount": 1,
  "maxAdmittedTeams": 1,
  "egressAllowlist": [
    {
      "version": 1,
      "cidr": "string",
      "port": 1,
      "protocol": "tcp",
      "packetsPerSecond": 1,
      "burstPackets": 1
    }
  ],
  "serviceInventoryRevision": "string"
}'
Response
{
  "allocationOperationId": "string",
  "delivered": true
}