> For the complete documentation index, see [llms.txt](https://docs.platform9.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform9.com/api-docs/networking-service/models.md).

# Models

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"detail":{"type":"string"}}}},"title":"Error"}}}}
```

## The VersionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"VersionsResponse":{"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/Version"}}},"title":"VersionsResponse"},"Version":{"type":"object","properties":{"status":{"enum":["CURRENT","SUPPORTED","DEPRECATED"],"type":"string"},"id":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"title":"Version"},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The Version object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Version":{"type":"object","properties":{"status":{"enum":["CURRENT","SUPPORTED","DEPRECATED"],"type":"string"},"id":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"title":"Version"},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The Link object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The ResourcesResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"ResourcesResponse":{"type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}},"title":"ResourcesResponse"},"Resource":{"type":"object","properties":{"name":{"type":"string"},"collection":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"title":"Resource"},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The Resource object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Resource":{"type":"object","properties":{"name":{"type":"string"},"collection":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"title":"Resource"},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The ExtensionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"ExtensionsResponse":{"type":"object","properties":{"extensions":{"type":"array","items":{"$ref":"#/components/schemas/Extension"}}},"title":"ExtensionsResponse"},"Extension":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"description":{"type":"string"},"updated":{"format":"date-time","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"title":"Extension"},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The ExtensionResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"ExtensionResponse":{"type":"object","properties":{"extension":{"$ref":"#/components/schemas/Extension"}},"title":"ExtensionResponse"},"Extension":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"description":{"type":"string"},"updated":{"format":"date-time","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"title":"Extension"},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The Extension object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Extension":{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"description":{"type":"string"},"updated":{"format":"date-time","type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"title":"Extension"},"Link":{"type":"object","properties":{"href":{"format":"uri","type":"string"},"rel":{"type":"string"}},"title":"Link"}}}}
```

## The NetworksResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"NetworksResponse":{"type":"object","properties":{"networks":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}},"title":"NetworksResponse"},"Network":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"admin_state_up":{"type":"boolean"},"status":{"enum":["ACTIVE","BUILD","DOWN","ERROR"],"type":"string","readOnly":true},"shared":{"type":"boolean"},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"subnets":{"type":"array","items":{"format":"uuid","type":"string"},"readOnly":true},"router:external":{"type":"boolean"},"provider:network_type":{"enum":["flat","vlan","vxlan","gre","local"],"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"},"mtu":{"minimum":68,"type":"integer"},"port_security_enabled":{"type":"boolean"},"dns_domain":{"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"availability_zone_hints":{"type":"array","items":{"type":"string"}},"availability_zones":{"type":"array","items":{"type":"string"},"readOnly":true},"ipv4_address_scope":{"format":"uuid","type":"string"},"ipv6_address_scope":{"format":"uuid","type":"string"},"l2_adjacency":{"type":"boolean","readOnly":true},"vlan_transparent":{"type":"boolean"},"qinq":{"type":"boolean"},"is_default":{"type":"boolean"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSegment"}},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Network"},"NetworkSegment":{"type":"object","properties":{"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"}},"title":"NetworkSegment"}}}}
```

## The NetworkResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"NetworkResponse":{"type":"object","properties":{"network":{"$ref":"#/components/schemas/Network"}},"title":"NetworkResponse"},"Network":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"admin_state_up":{"type":"boolean"},"status":{"enum":["ACTIVE","BUILD","DOWN","ERROR"],"type":"string","readOnly":true},"shared":{"type":"boolean"},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"subnets":{"type":"array","items":{"format":"uuid","type":"string"},"readOnly":true},"router:external":{"type":"boolean"},"provider:network_type":{"enum":["flat","vlan","vxlan","gre","local"],"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"},"mtu":{"minimum":68,"type":"integer"},"port_security_enabled":{"type":"boolean"},"dns_domain":{"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"availability_zone_hints":{"type":"array","items":{"type":"string"}},"availability_zones":{"type":"array","items":{"type":"string"},"readOnly":true},"ipv4_address_scope":{"format":"uuid","type":"string"},"ipv6_address_scope":{"format":"uuid","type":"string"},"l2_adjacency":{"type":"boolean","readOnly":true},"vlan_transparent":{"type":"boolean"},"qinq":{"type":"boolean"},"is_default":{"type":"boolean"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSegment"}},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Network"},"NetworkSegment":{"type":"object","properties":{"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"}},"title":"NetworkSegment"}}}}
```

## The Network object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Network":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"admin_state_up":{"type":"boolean"},"status":{"enum":["ACTIVE","BUILD","DOWN","ERROR"],"type":"string","readOnly":true},"shared":{"type":"boolean"},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"subnets":{"type":"array","items":{"format":"uuid","type":"string"},"readOnly":true},"router:external":{"type":"boolean"},"provider:network_type":{"enum":["flat","vlan","vxlan","gre","local"],"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"},"mtu":{"minimum":68,"type":"integer"},"port_security_enabled":{"type":"boolean"},"dns_domain":{"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"availability_zone_hints":{"type":"array","items":{"type":"string"}},"availability_zones":{"type":"array","items":{"type":"string"},"readOnly":true},"ipv4_address_scope":{"format":"uuid","type":"string"},"ipv6_address_scope":{"format":"uuid","type":"string"},"l2_adjacency":{"type":"boolean","readOnly":true},"vlan_transparent":{"type":"boolean"},"qinq":{"type":"boolean"},"is_default":{"type":"boolean"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSegment"}},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Network"},"NetworkSegment":{"type":"object","properties":{"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"}},"title":"NetworkSegment"}}}}
```

## The NetworkSegment object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"NetworkSegment":{"type":"object","properties":{"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"}},"title":"NetworkSegment"}}}}
```

## The NetworkCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"NetworkCreateRequest":{"type":"object","properties":{"network":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"admin_state_up":{"default":true,"type":"boolean"},"shared":{"default":false,"type":"boolean"},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"},"mtu":{"type":"integer"},"port_security_enabled":{"type":"boolean"},"dns_domain":{"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"router:external":{"type":"boolean"},"vlan_transparent":{"type":"boolean"},"is_default":{"type":"boolean"},"availability_zone_hints":{"type":"array","items":{"type":"string"}},"segments":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSegment"}}}}},"title":"NetworkCreateRequest"},"NetworkSegment":{"type":"object","properties":{"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"}},"title":"NetworkSegment"}}}}
```

## The NetworkUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"NetworkUpdateRequest":{"type":"object","properties":{"network":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"admin_state_up":{"type":"boolean"},"shared":{"type":"boolean"},"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"},"mtu":{"type":"integer"},"port_security_enabled":{"type":"boolean"},"dns_domain":{"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"router:external":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"segments":{"type":"array","items":{"$ref":"#/components/schemas/NetworkSegment"}}}}},"title":"NetworkUpdateRequest"},"NetworkSegment":{"type":"object","properties":{"provider:network_type":{"type":"string"},"provider:physical_network":{"type":"string"},"provider:segmentation_id":{"type":"integer"}},"title":"NetworkSegment"}}}}
```

## The PortsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"PortsResponse":{"type":"object","properties":{"ports":{"type":"array","items":{"$ref":"#/components/schemas/Port"}}},"title":"PortsResponse"},"Port":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"admin_state_up":{"type":"boolean"},"status":{"enum":["ACTIVE","BUILD","DOWN","ERROR"],"type":"string","readOnly":true},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"},"fixed_ips":{"type":"array","items":{"$ref":"#/components/schemas/FixedIP"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"device_id":{"type":"string"},"device_owner":{"type":"string"},"security_groups":{"type":"array","items":{"format":"uuid","type":"string"}},"allowed_address_pairs":{"type":"array","items":{"$ref":"#/components/schemas/AllowedAddressPair"}},"extra_dhcp_opts":{"type":"array","items":{"$ref":"#/components/schemas/ExtraDhcpOpt"}},"port_security_enabled":{"type":"boolean"},"dns_name":{"type":"string"},"dns_assignment":{"type":"array","items":{"$ref":"#/components/schemas/DnsAssignment"},"readOnly":true},"dns_domain":{"type":"string"},"data_plane_status":{"enum":[null,"ACTIVE","DOWN"],"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"qos_network_policy_id":{"format":"uuid","type":"string"},"binding:vnic_type":{"type":"string"},"binding:profile":{"type":"object","additionalProperties":true},"binding:host_id":{"type":"string"},"binding:vif_type":{"type":"string","readOnly":true},"binding:vif_details":{"type":"object","additionalProperties":true,"readOnly":true},"resource_request":{"type":"object","nullable":true,"readOnly":true},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Port"},"FixedIP":{"type":"object","properties":{"subnet_id":{"format":"uuid","type":"string"},"ip_address":{"format":"ipv4","type":"string"}},"title":"FixedIP"},"AllowedAddressPair":{"type":"object","properties":{"ip_address":{"type":"string"},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"}},"title":"AllowedAddressPair"},"ExtraDhcpOpt":{"type":"object","properties":{"opt_name":{"type":"string"},"opt_value":{"type":"string"},"ip_version":{"enum":[4,6],"type":"integer"}},"title":"ExtraDhcpOpt"},"DnsAssignment":{"type":"object","properties":{"hostname":{"type":"string"},"ip_address":{"type":"string"},"fqdn":{"type":"string"}},"title":"DnsAssignment"}}}}
```

## The PortResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"PortResponse":{"type":"object","properties":{"port":{"$ref":"#/components/schemas/Port"}},"title":"PortResponse"},"Port":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"admin_state_up":{"type":"boolean"},"status":{"enum":["ACTIVE","BUILD","DOWN","ERROR"],"type":"string","readOnly":true},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"},"fixed_ips":{"type":"array","items":{"$ref":"#/components/schemas/FixedIP"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"device_id":{"type":"string"},"device_owner":{"type":"string"},"security_groups":{"type":"array","items":{"format":"uuid","type":"string"}},"allowed_address_pairs":{"type":"array","items":{"$ref":"#/components/schemas/AllowedAddressPair"}},"extra_dhcp_opts":{"type":"array","items":{"$ref":"#/components/schemas/ExtraDhcpOpt"}},"port_security_enabled":{"type":"boolean"},"dns_name":{"type":"string"},"dns_assignment":{"type":"array","items":{"$ref":"#/components/schemas/DnsAssignment"},"readOnly":true},"dns_domain":{"type":"string"},"data_plane_status":{"enum":[null,"ACTIVE","DOWN"],"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"qos_network_policy_id":{"format":"uuid","type":"string"},"binding:vnic_type":{"type":"string"},"binding:profile":{"type":"object","additionalProperties":true},"binding:host_id":{"type":"string"},"binding:vif_type":{"type":"string","readOnly":true},"binding:vif_details":{"type":"object","additionalProperties":true,"readOnly":true},"resource_request":{"type":"object","nullable":true,"readOnly":true},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Port"},"FixedIP":{"type":"object","properties":{"subnet_id":{"format":"uuid","type":"string"},"ip_address":{"format":"ipv4","type":"string"}},"title":"FixedIP"},"AllowedAddressPair":{"type":"object","properties":{"ip_address":{"type":"string"},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"}},"title":"AllowedAddressPair"},"ExtraDhcpOpt":{"type":"object","properties":{"opt_name":{"type":"string"},"opt_value":{"type":"string"},"ip_version":{"enum":[4,6],"type":"integer"}},"title":"ExtraDhcpOpt"},"DnsAssignment":{"type":"object","properties":{"hostname":{"type":"string"},"ip_address":{"type":"string"},"fqdn":{"type":"string"}},"title":"DnsAssignment"}}}}
```

## The Port object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Port":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"admin_state_up":{"type":"boolean"},"status":{"enum":["ACTIVE","BUILD","DOWN","ERROR"],"type":"string","readOnly":true},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"},"fixed_ips":{"type":"array","items":{"$ref":"#/components/schemas/FixedIP"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"device_id":{"type":"string"},"device_owner":{"type":"string"},"security_groups":{"type":"array","items":{"format":"uuid","type":"string"}},"allowed_address_pairs":{"type":"array","items":{"$ref":"#/components/schemas/AllowedAddressPair"}},"extra_dhcp_opts":{"type":"array","items":{"$ref":"#/components/schemas/ExtraDhcpOpt"}},"port_security_enabled":{"type":"boolean"},"dns_name":{"type":"string"},"dns_assignment":{"type":"array","items":{"$ref":"#/components/schemas/DnsAssignment"},"readOnly":true},"dns_domain":{"type":"string"},"data_plane_status":{"enum":[null,"ACTIVE","DOWN"],"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"qos_network_policy_id":{"format":"uuid","type":"string"},"binding:vnic_type":{"type":"string"},"binding:profile":{"type":"object","additionalProperties":true},"binding:host_id":{"type":"string"},"binding:vif_type":{"type":"string","readOnly":true},"binding:vif_details":{"type":"object","additionalProperties":true,"readOnly":true},"resource_request":{"type":"object","nullable":true,"readOnly":true},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Port"},"FixedIP":{"type":"object","properties":{"subnet_id":{"format":"uuid","type":"string"},"ip_address":{"format":"ipv4","type":"string"}},"title":"FixedIP"},"AllowedAddressPair":{"type":"object","properties":{"ip_address":{"type":"string"},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"}},"title":"AllowedAddressPair"},"ExtraDhcpOpt":{"type":"object","properties":{"opt_name":{"type":"string"},"opt_value":{"type":"string"},"ip_version":{"enum":[4,6],"type":"integer"}},"title":"ExtraDhcpOpt"},"DnsAssignment":{"type":"object","properties":{"hostname":{"type":"string"},"ip_address":{"type":"string"},"fqdn":{"type":"string"}},"title":"DnsAssignment"}}}}
```

## The FixedIP object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"FixedIP":{"type":"object","properties":{"subnet_id":{"format":"uuid","type":"string"},"ip_address":{"format":"ipv4","type":"string"}},"title":"FixedIP"}}}}
```

## The AllowedAddressPair object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"AllowedAddressPair":{"type":"object","properties":{"ip_address":{"type":"string"},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"}},"title":"AllowedAddressPair"}}}}
```

## The ExtraDhcpOpt object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"ExtraDhcpOpt":{"type":"object","properties":{"opt_name":{"type":"string"},"opt_value":{"type":"string"},"ip_version":{"enum":[4,6],"type":"integer"}},"title":"ExtraDhcpOpt"}}}}
```

## The DnsAssignment object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"DnsAssignment":{"type":"object","properties":{"hostname":{"type":"string"},"ip_address":{"type":"string"},"fqdn":{"type":"string"}},"title":"DnsAssignment"}}}}
```

## The PortCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"PortCreateRequest":{"required":["port"],"type":"object","properties":{"port":{"required":["network_id"],"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"admin_state_up":{"default":true,"type":"boolean"},"mac_address":{"type":"string"},"fixed_ips":{"type":"array","items":{"$ref":"#/components/schemas/FixedIP"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"device_id":{"type":"string"},"device_owner":{"type":"string"},"security_groups":{"type":"array","items":{"format":"uuid","type":"string"}},"allowed_address_pairs":{"type":"array","items":{"$ref":"#/components/schemas/AllowedAddressPair"}},"extra_dhcp_opts":{"type":"array","items":{"$ref":"#/components/schemas/ExtraDhcpOpt"}},"port_security_enabled":{"type":"boolean"},"dns_name":{"type":"string"},"dns_domain":{"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"},"binding:vnic_type":{"type":"string"},"binding:profile":{"type":"object","additionalProperties":true}}}},"title":"PortCreateRequest"},"FixedIP":{"type":"object","properties":{"subnet_id":{"format":"uuid","type":"string"},"ip_address":{"format":"ipv4","type":"string"}},"title":"FixedIP"},"AllowedAddressPair":{"type":"object","properties":{"ip_address":{"type":"string"},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"}},"title":"AllowedAddressPair"},"ExtraDhcpOpt":{"type":"object","properties":{"opt_name":{"type":"string"},"opt_value":{"type":"string"},"ip_version":{"enum":[4,6],"type":"integer"}},"title":"ExtraDhcpOpt"}}}}
```

## The PortUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"PortUpdateRequest":{"type":"object","properties":{"port":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"admin_state_up":{"type":"boolean"},"fixed_ips":{"type":"array","items":{"$ref":"#/components/schemas/FixedIP"}},"device_id":{"type":"string"},"device_owner":{"type":"string"},"security_groups":{"type":"array","items":{"format":"uuid","type":"string"}},"allowed_address_pairs":{"type":"array","items":{"$ref":"#/components/schemas/AllowedAddressPair"}},"extra_dhcp_opts":{"type":"array","items":{"$ref":"#/components/schemas/ExtraDhcpOpt"}},"port_security_enabled":{"type":"boolean"},"dns_name":{"type":"string"},"dns_domain":{"type":"string"},"data_plane_status":{"enum":[null,"ACTIVE","DOWN"],"type":"string"},"qos_policy_id":{"format":"uuid","type":"string"}}}},"title":"PortUpdateRequest"},"FixedIP":{"type":"object","properties":{"subnet_id":{"format":"uuid","type":"string"},"ip_address":{"format":"ipv4","type":"string"}},"title":"FixedIP"},"AllowedAddressPair":{"type":"object","properties":{"ip_address":{"type":"string"},"mac_address":{"pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"}},"title":"AllowedAddressPair"},"ExtraDhcpOpt":{"type":"object","properties":{"opt_name":{"type":"string"},"opt_value":{"type":"string"},"ip_version":{"enum":[4,6],"type":"integer"}},"title":"ExtraDhcpOpt"}}}}
```

## The SubnetsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"SubnetsResponse":{"type":"object","properties":{"subnets":{"type":"array","items":{"$ref":"#/components/schemas/Subnet"}}},"title":"SubnetsResponse"},"Subnet":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"ip_version":{"enum":[4,6],"type":"integer"},"cidr":{"type":"string"},"gateway_ip":{"type":"string"},"dhcp_enabled":{"type":"boolean"},"dns_nameservers":{"type":"array","items":{"type":"string"}},"allocation_pools":{"type":"array","items":{"$ref":"#/components/schemas/AllocationPool"}},"host_routes":{"type":"array","items":{"$ref":"#/components/schemas/HostRoute"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"ipv6_address_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"ipv6_ra_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"subnetpool_id":{"format":"uuid","type":"string"},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Subnet"},"AllocationPool":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"title":"AllocationPool"},"HostRoute":{"type":"object","properties":{"destination":{"type":"string"},"nexthop":{"type":"string"}},"title":"HostRoute"}}}}
```

## The SubnetResponse object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"SubnetResponse":{"type":"object","properties":{"subnet":{"$ref":"#/components/schemas/Subnet"}},"title":"SubnetResponse"},"Subnet":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"ip_version":{"enum":[4,6],"type":"integer"},"cidr":{"type":"string"},"gateway_ip":{"type":"string"},"dhcp_enabled":{"type":"boolean"},"dns_nameservers":{"type":"array","items":{"type":"string"}},"allocation_pools":{"type":"array","items":{"$ref":"#/components/schemas/AllocationPool"}},"host_routes":{"type":"array","items":{"$ref":"#/components/schemas/HostRoute"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"ipv6_address_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"ipv6_ra_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"subnetpool_id":{"format":"uuid","type":"string"},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Subnet"},"AllocationPool":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"title":"AllocationPool"},"HostRoute":{"type":"object","properties":{"destination":{"type":"string"},"nexthop":{"type":"string"}},"title":"HostRoute"}}}}
```

## The Subnet object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"Subnet":{"type":"object","properties":{"id":{"format":"uuid","type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"ip_version":{"enum":[4,6],"type":"integer"},"cidr":{"type":"string"},"gateway_ip":{"type":"string"},"dhcp_enabled":{"type":"boolean"},"dns_nameservers":{"type":"array","items":{"type":"string"}},"allocation_pools":{"type":"array","items":{"$ref":"#/components/schemas/AllocationPool"}},"host_routes":{"type":"array","items":{"$ref":"#/components/schemas/HostRoute"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"ipv6_address_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"ipv6_ra_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"subnetpool_id":{"format":"uuid","type":"string"},"tags":{"type":"array","items":{"type":"string"}},"revision_number":{"type":"integer","readOnly":true},"created_at":{"format":"date-time","type":"string","readOnly":true},"updated_at":{"format":"date-time","type":"string","readOnly":true}},"title":"Subnet"},"AllocationPool":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"title":"AllocationPool"},"HostRoute":{"type":"object","properties":{"destination":{"type":"string"},"nexthop":{"type":"string"}},"title":"HostRoute"}}}}
```

## The AllocationPool object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"AllocationPool":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"title":"AllocationPool"}}}}
```

## The HostRoute object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"HostRoute":{"type":"object","properties":{"destination":{"type":"string"},"nexthop":{"type":"string"}},"title":"HostRoute"}}}}
```

## The SubnetCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"SubnetCreateRequest":{"required":["subnet"],"type":"object","properties":{"subnet":{"required":["network_id","cidr","ip_version"],"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"network_id":{"format":"uuid","type":"string"},"ip_version":{"enum":[4,6],"type":"integer"},"cidr":{"type":"string"},"gateway_ip":{"type":"string"},"dhcp_enabled":{"default":true,"type":"boolean"},"dns_nameservers":{"type":"array","items":{"type":"string"}},"allocation_pools":{"type":"array","items":{"$ref":"#/components/schemas/AllocationPool"}},"host_routes":{"type":"array","items":{"$ref":"#/components/schemas/HostRoute"}},"project_id":{"format":"uuid","type":"string"},"tenant_id":{"format":"uuid","type":"string"},"ipv6_address_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"ipv6_ra_mode":{"enum":["slaac","dhcpv6-stateful","dhcpv6-stateless"],"type":"string"},"subnetpool_id":{"format":"uuid","type":"string"}}}},"title":"SubnetCreateRequest"},"AllocationPool":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"title":"AllocationPool"},"HostRoute":{"type":"object","properties":{"destination":{"type":"string"},"nexthop":{"type":"string"}},"title":"HostRoute"}}}}
```

## The SubnetUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Networking API","version":"2.0"},"components":{"schemas":{"SubnetUpdateRequest":{"type":"object","properties":{"subnet":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"gateway_ip":{"type":"string"},"dhcp_enabled":{"type":"boolean"},"dns_nameservers":{"type":"array","items":{"type":"string"}},"allocation_pools":{"type":"array","items":{"$ref":"#/components/schemas/AllocationPool"}},"host_routes":{"type":"array","items":{"$ref":"#/components/schemas/HostRoute"}}}}},"title":"SubnetUpdateRequest"},"AllocationPool":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}},"title":"AllocationPool"},"HostRoute":{"type":"object","properties":{"destination":{"type":"string"},"nexthop":{"type":"string"}},"title":"HostRoute"}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.platform9.com/api-docs/networking-service/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.