---
title: "Update a device interface"
method: PATCH
path: "/{org_slug}/device-interfaces/{id}"
tags: ["Devices"]
---

# Update a device interface

`PATCH /{org_slug}/device-interfaces/{id}`

## Request

- Base URL: `https://api.obelinf.com`
- URL: `https://api.obelinf.com/{org_slug}/device-interfaces/{id}`
- Auth: HTTP bearer

Update a device interface

## Path parameters

- `org_slug` string, required
- `id` string, required

## Request body

- object
  - `description` string, nullable
  - `device_id` string
  - `enabled` boolean
  - `lag_id` string, nullable
  - `mac_address` string, nullable
  - `mode` union
    - 'access'
    - 'trunk'
  - `mtu` number, nullable
  - `name` string
  - `parent_id` string, nullable
  - `tagged_vlan_ids` string[]
  - `type` string
  - `untagged_vlan_id` string, nullable

## Response `200`

Interface updated

- object
  - `interface` object, required
    - `created_at` string, required
    - `device_id` string, required
    - `enabled` boolean, required
    - `id` string, required
    - `name` string, required
    - `tagged_vlans` object[], required
      - `id` string, required
      - `vlan_id` string, required
      - `name` string, nullable
      - `vid` number, nullable
    - `type` string, required
    - `updated_at` string, required
    - `description` string, nullable
    - `lag_id` string, nullable
    - `lag_name` string, nullable
    - `mac_address` string, nullable
    - `mode` union
      - 'access'
      - 'trunk'
    - `mtu` number, nullable
    - `parent_id` string, nullable
    - `parent_name` string, nullable
    - `untagged_vlan_id` string, nullable
    - `untagged_vlan_name` string, nullable
    - `untagged_vlan_vid` number, nullable
  - `mac_addresses` object[], required
    - `address` string, required
    - `id` string, required
    - `interface_id` string, required
    - `description` string, nullable
  - `tags` object[], required
    - `id` string, required
    - `tag_id` string, required
    - `tag_name` string, required
    - `tag_color` string, nullable
  - `wireless_lans` object[], required
    - `id` string, required
    - `wireless_lan_id` string, required
    - `role` string, nullable
    - `wireless_lan_name` string, nullable
    - `wireless_lan_ssid` string, nullable

## Other responses

- `400`: Validation error
- `404`: Not found

---

[API](https://skmtc.dev/obelinf/apis/obelinf-api.md) · [All operations](https://skmtc.dev/obelinf/apis/obelinf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/obelinf/apis/obelinf-api/revisions/463fcf791828?raw)