Sign in
Ports

Update a port

put/api/v1/ports/{id}

Path parameters

idstring uuid required

Port ID

Request body

numberinteger required
protocol'Udp' | 'Tcp' required
typestring

Auto-derived from number+protocol; optional on create

host_idstring uuid required
network_idstring uuid required
created_atstring date-time required
idstring uuid required
updated_atstring date-time required

Example request

{
  "created_at": "2026-01-15T10:30:00Z",
  "host_id": "550e8400-e29b-41d4-a716-446655440003",
  "id": "550e8400-e29b-41d4-a716-446655440006",
  "network_id": "550e8400-e29b-41d4-a716-446655440002",
  "number": 80,
  "protocol": "Tcp",
  "type": "Http",
  "updated_at": "2026-01-15T10:30:00Z"
}

Response

Port updated successfully

errorstring nullable
successboolean required

Example response

{
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "host_id": "550e8400-e29b-41d4-a716-446655440003",
    "id": "550e8400-e29b-41d4-a716-446655440006",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "number": 80,
    "protocol": "Tcp",
    "type": "Http",
    "updated_at": "2026-01-15T10:30:00Z"
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  }
}

Changes