LogoLogo
GitHubWebsite
  • Documentation
  • Client API
  • Application API
  • Client API
  • Authentication
  • Users
  • API Keys
  • Nodes
  • Allocations
  • Regions
  • Units
  • Servers
  • Cargo
  • Projects
  • System
  • Models
Powered by GitBook

© Argon Foundation

On this page

Was this helpful?

Export as PDF

Allocations

PreviousNodesNextRegions

Was this helpful?

  • POSTCreate allocation
  • DELETEDelete allocation

Delete allocation

delete

Delete an allocation from a node

Authorizations
Path parameters
nodeIdstring · uuidRequired
allocationIdstring · uuidRequired
Responses
204
Allocation deleted successfully
400
Cannot delete allocation in use
application/json
403
Forbidden
application/json
404
Node or allocation not found
application/json
500
Server error
application/json
delete
DELETE /api/nodes/{nodeId}/allocations/{allocationId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

No content

Create allocation

post

Create a new allocation for a node

Authorizations
Path parameters
idstring · uuidRequired

Node ID

Body
one ofOptional
or
Responses
201
Allocation created successfully
application/json
Responseone of
or
400
Invalid request or port already allocated
application/json
403
Forbidden
application/json
404
Node not found
application/json
500
Server error
application/json
post
POST /api/nodes/{id}/allocations HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "bindAddress": "text",
  "port": 1,
  "alias": "text",
  "notes": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "nodeId": "123e4567-e89b-12d3-a456-426614174000",
  "bindAddress": "text",
  "port": 1,
  "alias": "text",
  "notes": "text",
  "assigned": true,
  "serverId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-05-20T02:43:26.277Z",
  "updatedAt": "2025-05-20T02:43:26.277Z"
}