ScanopyScanopy
Interfaces

PUT
/api/v1/interfaces/{id}

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Path Parameters

id*string

Interface ID

Formatuuid

Request Body

application/json

host_id*string
Formatuuid
ip_address*string
mac_address*string|null
name*string|null
network_id*string
Formatuuid
subnet_id*string
Formatuuid
position?integer

Position of this interface in the host's interface list (for ordering)

Formatint32

Response Body

application/json

application/json

application/json

curl -X PUT "https://loading/api/v1/interfaces/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "created_at": "2026-01-15T10:30:00Z",    "host_id": "550e8400-e29b-41d4-a716-446655440003",    "id": "550e8400-e29b-41d4-a716-446655440005",    "ip_address": "192.168.1.100",    "mac_address": "DE:AD:BE:EF:12:34",    "name": "eth0",    "network_id": "550e8400-e29b-41d4-a716-446655440002",    "position": 0,    "subnet_id": "550e8400-e29b-41d4-a716-446655440004",    "updated_at": "2026-01-15T10:30:00Z"  }'
{
  "meta": {
    "api_version": 1,
    "server_version": "0.13.5"
  },
  "success": true,
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "host_id": "550e8400-e29b-41d4-a716-446655440003",
    "id": "550e8400-e29b-41d4-a716-446655440005",
    "ip_address": "192.168.1.100",
    "mac_address": "DE:AD:BE:EF:12:34",
    "name": "eth0",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "position": 0,
    "subnet_id": "550e8400-e29b-41d4-a716-446655440004",
    "updated_at": "2026-01-15T10:30:00Z"
  },
  "error": "string"
}
{
  "success": true,
  "error": "string"
}
{
  "success": true,
  "error": "string"
}

Previous Page

Next Page