> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/system-configuration/network-interfaces.md).

# Network interfaces

The network interfaces on the system's c.nodes.

Use these endpoints to review interface configuration, or to change an interface's IP address or external address.

## GET /system/net\_interfaces

> List network interfaces

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Network interfaces","description":"The network interfaces on the system's c.nodes.\n\nUse these endpoints to review interface configuration, or to change an interface's IP address or external address."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"parameters":{"limit":{"name":"__limit","in":"query","schema":{"type":"integer"},"description":"Caps the number of returned entities. Requires a sort parameter when paging."},"offset":{"name":"__offset","in":"query","schema":{"type":"integer"},"description":"Returns results starting from this offset. Requires a sort parameter when paging."},"sort":{"name":"__sort","in":"query","schema":{"type":"string"},"description":"Comma-separated object properties to sort by."},"sort_order":{"name":"__sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"]},"description":"Sort direction."}},"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}},"SystemNetInterfaces":{"type":"object","properties":{"eth_name":{"type":"string","description":"Underlying OS interface name (e.g. `eth3`, `ib0`)."},"id":{"type":"integer","description":"Unique identifier."},"if_ip":{"type":"string","description":"IPv4 address bound to the interface."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while the interface is being reconfigured as part of an expansion operation."},"name":{"type":"string","description":"Interface name (e.g. `c-node04_netif-mgmt01`)."},"port":{"$ref":"#/components/schemas/Ref","description":"Reference to the underlying physical port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"port_type":{"type":"string","description":"Logical role of the interface, e.g. `netif-mgmt` or `netif-external`."},"server":{"$ref":"#/components/schemas/Ref","description":"Reference to the server the interface lives on. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"status":{"type":"string","description":"Interface status, e.g. `ok`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/net_interfaces":{"get":{"tags":["Network interfaces"],"summary":"List network interfaces","operationId":"listSystemNetInterfaces","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/SystemNetInterfaces"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## GET /system/net\_interfaces/{id}

> Get a network interface

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Network interfaces","description":"The network interfaces on the system's c.nodes.\n\nUse these endpoints to review interface configuration, or to change an interface's IP address or external address."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"SystemNetInterfaces":{"type":"object","properties":{"eth_name":{"type":"string","description":"Underlying OS interface name (e.g. `eth3`, `ib0`)."},"id":{"type":"integer","description":"Unique identifier."},"if_ip":{"type":"string","description":"IPv4 address bound to the interface."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while the interface is being reconfigured as part of an expansion operation."},"name":{"type":"string","description":"Interface name (e.g. `c-node04_netif-mgmt01`)."},"port":{"$ref":"#/components/schemas/Ref","description":"Reference to the underlying physical port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"port_type":{"type":"string","description":"Logical role of the interface, e.g. `netif-mgmt` or `netif-external`."},"server":{"$ref":"#/components/schemas/Ref","description":"Reference to the server the interface lives on. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"status":{"type":"string","description":"Interface status, e.g. `ok`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/net_interfaces/{id}":{"get":{"tags":["Network interfaces"],"summary":"Get a network interface","operationId":"getSystemNetInterfaces","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemNetInterfaces"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /system/net\_interfaces/{id}

> Update network interface

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Network interfaces","description":"The network interfaces on the system's c.nodes.\n\nUse these endpoints to review interface configuration, or to change an interface's IP address or external address."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"SystemNetInterfaces":{"type":"object","properties":{"eth_name":{"type":"string","description":"Underlying OS interface name (e.g. `eth3`, `ib0`)."},"id":{"type":"integer","description":"Unique identifier."},"if_ip":{"type":"string","description":"IPv4 address bound to the interface."},"is_expansion_in_progress":{"type":"boolean","description":"`true` while the interface is being reconfigured as part of an expansion operation."},"name":{"type":"string","description":"Interface name (e.g. `c-node04_netif-mgmt01`)."},"port":{"$ref":"#/components/schemas/Ref","description":"Reference to the underlying physical port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"port_type":{"type":"string","description":"Logical role of the interface, e.g. `netif-mgmt` or `netif-external`."},"server":{"$ref":"#/components/schemas/Ref","description":"Reference to the server the interface lives on. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"status":{"type":"string","description":"Interface status, e.g. `ok`."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/net_interfaces/{id}":{"patch":{"tags":["Network interfaces"],"summary":"Update network interface","operationId":"updateSystemNetInterfaces","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Update network interface","properties":{"server":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the server the interface lives on. Shape: `{ \"ref\": \"/system/servers/{id}\" }`."},"if_ip":{"$ref":"#/components/schemas/SystemNetInterfaces/properties/if_ip"},"external_ip":{"type":"string"},"external_mask":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemNetInterfaces"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/system-configuration/network-interfaces.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
