Endpoint

/v2/network/interfaces/{interface_id}/networks/

GET

Get configurations of all networks configured on an interface. This will always include at least one network, and exactly one if it is assigned by DHCP. Network 1 is created by default, but it may be removed if other networks are created viastatic assignment.

Parameters

Name Description Required
interface_id The unique ID of the network interface Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "api_network_config_v2",
    "type": "object",
    "properties": {
      "name": {
        "description": "name",
        "type": "string"
      },
      "id": {
        "description": "id",
        "type": "number"
      },
      "assigned_by": {
        "type": "string",
        "enum": [
          "DHCP",
          "STATIC",
          "LINK_LOCAL"
        ],
        "description": "assigned_by:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"
      },
      "floating_ip_ranges": {
        "type": "array",
        "items": {
          "description": "floating_ip_ranges",
          "type": "string"
        }
      },
      "dns_servers": {
        "type": "array",
        "items": {
          "description": "dns_servers",
          "type": "string"
        }
      },
      "dns_search_domains": {
        "type": "array",
        "items": {
          "description": "dns_search_domains",
          "type": "string"
        }
      },
      "ip_ranges": {
        "type": "array",
        "items": {
          "description": "ip_ranges",
          "type": "string"
        }
      },
      "netmask": {
        "description": "netmask",
        "type": "string"
      },
      "mtu": {
        "description": "mtu",
        "type": "number"
      },
      "vlan_id": {
        "description": "User assigned VLAN tag for network configuration. 1-4094 are valid VLAN IDs and 0 is used for untagged networks.",
        "type": "number"
      },
      "tenant_id": {
        "description": "The tenant ID of the tenant that the network is a part of.",
        "type": "number"
      }
    }
  }
}

POST

Add a network configuration to the interface. If the network being added is an untagged STATIC network, the MTU will be computed based on the interface configuration.

Parameters

Name Description Required
interface_id The unique ID of the network interface Yes

Request

Schema

{
  "description": "api_network_config_v2",
  "type": "object",
  "properties": {
    "name": {
      "description": "name",
      "type": "string"
    },
    "id": {
      "description": "id",
      "type": "number"
    },
    "assigned_by": {
      "type": "string",
      "enum": [
        "DHCP",
        "STATIC",
        "LINK_LOCAL"
      ],
      "description": "assigned_by:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"
    },
    "floating_ip_ranges": {
      "type": "array",
      "items": {
        "description": "floating_ip_ranges",
        "type": "string"
      }
    },
    "dns_servers": {
      "type": "array",
      "items": {
        "description": "dns_servers",
        "type": "string"
      }
    },
    "dns_search_domains": {
      "type": "array",
      "items": {
        "description": "dns_search_domains",
        "type": "string"
      }
    },
    "ip_ranges": {
      "type": "array",
      "items": {
        "description": "ip_ranges",
        "type": "string"
      }
    },
    "netmask": {
      "description": "netmask",
      "type": "string"
    },
    "mtu": {
      "description": "mtu",
      "type": "number"
    },
    "vlan_id": {
      "description": "User assigned VLAN tag for network configuration. 1-4094 are valid VLAN IDs and 0 is used for untagged networks.",
      "type": "number"
    },
    "tenant_id": {
      "description": "The tenant ID of the tenant that the network is a part of.",
      "type": "number"
    }
  }
}

Response

Codes

Code Description
202 Return value on success