Authorizations
API key for authentication. Make sure to include the word apikey
, followed by a single space and then your token.
Example: apikey 1234$abcdef
Path Parameters
Project ID
1
Region ID
1
Network ID
"b39792c3-3160-4356-912e-ba396c95cdcf"
Body
Name.
"some_name"
Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null
to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.
Examples:
* Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}}
adds new tags or updates existing ones.
* Delete tags: {'tags': {'
old_tag': null}}
removes specific tags.
* Remove all tags: {'tags': null}
removes all user-managed tags (read-only tags are preserved).
* Partial update: {'tags': {'environment': 'staging'}}
only updates specified tags.
* Mixed operations: {'tags': {'environment': 'production', '
cost_center': 'engineering', '
deprecated_tag': null}}
adds/updates 'environment' and 'cost_center
' while removing 'deprecated_tag
', preserving other existing tags.
* Replace all: first delete existing tags with null values, then add new ones in the same request.
{
"my-tag": "my-tag-value",
"my-tag-to-remove": null
}
Response
OK
Datetime when the network was created
"2019-06-18T11:56:16+0000"
Task that created this entity
"fd50fdd1-0482-4c9b-b847-fc9924665af6"
True if network has is_default
attribute
true
True if the network router:external
attribute
true
Network ID
"eed97610-708d-43a5-a9a5-caebd2b7b4ee"
MTU (maximum transmission unit). Default value is 1450
1500
Network name
"public"
Indicates port_security_enabled
status of all newly created in the network ports.
true
false
Project ID
1337
Region name
"Luxembourg 1"
Region ID
7
Id of network segment
9
True when the network is shared with your project by external owner
false
List of subnetworks
[
"f00624ab-41bc-4d54-a723-1673ce32d997",
"41e0f698-4d39-483b-b77a-18eb070e4c09"
]
List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
[
{
"key": "my-tag",
"read_only": false,
"value": "my-tag-value"
}
]
The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null
, the resource is not locked.
null
Network type (vlan, vxlan)
"vlan"
Datetime when the network was last updated
"2019-06-18T11:57:00+0000"