> 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-ips.md).

# Network IPs

The IP addresses assigned to the system's ports, and the service each one carries, such as iSCSI.

Use these endpoints to add IP addresses for host or replication connectivity, or to remove addresses you no longer use.

## GET /system/net\_ips

> List network IPs

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Network IPs","description":"The IP addresses assigned to the system's ports, and the service each one carries, such as iSCSI.\n\nUse these endpoints to add IP addresses for host or replication connectivity, or to remove addresses you no longer use."}],"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."}}},"SystemNetIps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"IPv4 address."},"net_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the underlying physical network port, when the IP is bound directly to a port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"net_portchannel":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound port channel, if any. Shape: `{ \"ref\": \"/system/net_portchannels/{id}\" }`."},"net_vlan":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound VLAN interface, if any. Shape: `{ \"ref\": \"/system/net_vlans/{id}\" }`."},"network_mask":{"type":"string","description":"IPv4 network mask in dotted-decimal form."},"nvme_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound NVMe port, if any."},"wan_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound WAN port, if any. Shape: `{ \"ref\": \"/system/wan_ports/{id}\" }`."}}},"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_ips":{"get":{"tags":["Network IPs"],"summary":"List network IPs","operationId":"listSystemNetIps","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/SystemNetIps"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /system/net\_ips

> Add IP

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Network IPs","description":"The IP addresses assigned to the system's ports, and the service each one carries, such as iSCSI.\n\nUse these endpoints to add IP addresses for host or replication connectivity, or to remove addresses you no longer use."}],"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":{"SystemNetIps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"IPv4 address."},"net_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the underlying physical network port, when the IP is bound directly to a port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"net_portchannel":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound port channel, if any. Shape: `{ \"ref\": \"/system/net_portchannels/{id}\" }`."},"net_vlan":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound VLAN interface, if any. Shape: `{ \"ref\": \"/system/net_vlans/{id}\" }`."},"network_mask":{"type":"string","description":"IPv4 network mask in dotted-decimal form."},"nvme_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound NVMe port, if any."},"wan_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound WAN port, if any. Shape: `{ \"ref\": \"/system/wan_ports/{id}\" }`."}}},"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_ips":{"post":{"tags":["Network IPs"],"summary":"Add IP","operationId":"createSystemNetIps","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemNetIps"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Add IP","properties":{"ip_address":{"type":"string","description":"IPv4 address."},"service":{"type":"string","description":"Service the IP carries, e.g. `iscsi`."},"network_mask":{"$ref":"#/components/schemas/SystemNetIps/properties/network_mask"},"interface":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the underlying entity to bind the IP to. Typically a `net_ports`, `net_portchannels`, or `net_vlans` ref. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."}},"required":["ip_address","service","network_mask","interface"]}}}}}}}}
```

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

> Get a network IP

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Network IPs","description":"The IP addresses assigned to the system's ports, and the service each one carries, such as iSCSI.\n\nUse these endpoints to add IP addresses for host or replication connectivity, or to remove addresses you no longer use."}],"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":{"SystemNetIps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"IPv4 address."},"net_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the underlying physical network port, when the IP is bound directly to a port. Shape: `{ \"ref\": \"/system/net_ports/{id}\" }`."},"net_portchannel":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound port channel, if any. Shape: `{ \"ref\": \"/system/net_portchannels/{id}\" }`."},"net_vlan":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound VLAN interface, if any. Shape: `{ \"ref\": \"/system/net_vlans/{id}\" }`."},"network_mask":{"type":"string","description":"IPv4 network mask in dotted-decimal form."},"nvme_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound NVMe port, if any."},"wan_port":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the bound WAN port, if any. Shape: `{ \"ref\": \"/system/wan_ports/{id}\" }`."}}},"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_ips/{id}":{"get":{"tags":["Network IPs"],"summary":"Get a network IP","operationId":"getSystemNetIps","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemNetIps"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /system/net\_ips/{id}

> Delete a network IP

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Network IPs","description":"The IP addresses assigned to the system's ports, and the service each one carries, such as iSCSI.\n\nUse these endpoints to add IP addresses for host or replication connectivity, or to remove addresses you no longer use."}],"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`)."}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}}},"paths":{"/system/net_ips/{id}":{"delete":{"tags":["Network IPs"],"summary":"Delete a network IP","operationId":"deleteSystemNetIps","responses":{"204":{"description":"No content"},"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-ips.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.
