Get Network VPC

GET 
/backend/api/openstack/networks

Host: https://core.ocplanet.cloud

Access information related to networks.

Request

Query Parameters

filtering string
ordering string
page string
page_size string

Responses

200

application/json

Schema

Schema

count integerrequired
next object required

oneOf

MOD1

string

previous object required

oneOf

MOD1

string

objects object[]required
Array [
id stringrequired
extra objectrequired
availability_zones arrayrequired
subnets object[]required
Array [
id stringrequired
name stringrequired
cidr stringrequired
ip_version integerrequired
gateway_ip stringrequired
project_id stringrequired
enable_dhcp booleanrequired
extra stringrequired
allocation_pools stringrequired
has_edit_permission booleanrequired
has_delete_permission booleanrequired
]
allowed_actions string[]required
name stringrequired
description stringrequired
shared booleanrequired
router_external booleanrequired
is_default booleanrequired
status stringrequired
admin_state_up booleanrequired
created_at stringrequired
updated_at stringrequired
region stringrequired
project stringrequired
]
totalCount integerrequired
pageNo object required

oneOf

MOD1

string

MOD2

integer

permissions objectrequired
networks.list booleanrequired
networks.retrieve booleanrequired
networks.create booleanrequired
networks.destroy booleanrequired
networks.auto_create_network booleanrequired
networks.update booleanrequired
networks.save_auto_create_network_options booleanrequired

Example (from schema)

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "objects": [
    {
      "id": "string",
      "extra": {
        "availability_zones": [
          null
        ]
      },
      "subnets": [
        {
          "id": "string",
          "name": "string",
          "cidr": "string",
          "ip_version": 0,
          "gateway_ip": "string",
          "project_id": "string",
          "enable_dhcp": true,
          "extra": "string",
          "allocation_pools": "string",
          "has_edit_permission": true,
          "has_delete_permission": true
        }
      ],
      "allowed_actions": [
        "string"
      ],
      "name": "string",
      "description": "string",
      "shared": true,
      "router_external": true,
      "is_default": true,
      "status": "string",
      "admin_state_up": true,
      "created_at": "string",
      "updated_at": "string",
      "region": "string",
      "project": "string"
    }
  ],
  "totalCount": 0,
  "pageNo": "string",
  "permissions": {
    "networks.list": true,
    "networks.retrieve": true,
    "networks.create": true,
    "networks.destroy": true,
    "networks.auto_create_network": true,
    "networks.update": true,
    "networks.save_auto_create_network_options": true
  }
}

Example

{
  "count": 2,
  "next": null,
  "previous": null,
  "objects": [
    {
      "id": "ac280db2-cf06-49d4-94bd-66b5c0167dc4",
      "extra": {
        "provider:physical_network": null,
        "provider:network_type": "vxlan",
        "provider:segmentation_id": 560,
        "availability_zones": [
          "nova"
        ]
      },
      "subnets": [
        {
          "id": "b968f4d5-9586-442a-996d-da570a4a6d9d",
          "name": "subnet41914",
          "cidr": "10.0.1.0/24",
          "ip_version": 4,
          "gateway_ip": "10.0.1.1",
          "project_id": "41e4ce1e550a4b4c922db7c287cf5a53",
          "enable_dhcp": true,
          "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
          "allocation_pools": "[{'start': '10.0.1.2', 'end': '10.0.1.254'}]",
          "has_edit_permission": true,
          "has_delete_permission": true
        }
      ],
      "allowed_actions": [
        "update",
        "delete",
        "add_subnet",
        "add_router"
      ],
      "name": "network60199",
      "description": "",
      "shared": false,
      "router_external": false,
      "is_default": false,
      "status": "ACTIVE",
      "admin_state_up": true,
      "created_at": "2024-02-28T07:37:04Z",
      "updated_at": "2024-02-28T07:37:05Z",
      "region": "ua-central-1",
      "project": "41e4ce1e550a4b4c922db7c287cf5a53"
    },
    {
      "id": "5cf72c55-b9cd-4706-862a-6bc4c3e41bfc",
      "extra": {
        "provider:physical_network": "physnet1",
        "provider:network_type": "vlan",
        "provider:segmentation_id": 15,
        "availability_zones": [
          "nova"
        ]
      },
      "subnets": [
        {
          "id": "7e21d26b-f92a-4265-a073-c4abef1fbd9b",
          "name": "external_subnet1",
          "cidr": "2.59.220.0/22",
          "ip_version": 4,
          "gateway_ip": "2.59.220.1",
          "project_id": "c712e3d141fa4a20b393320ac2bd1065",
          "enable_dhcp": false,
          "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
          "allocation_pools": "[{'start': '2.59.220.215', 'end': '2.59.220.254'}, {'start': '2.59.223.2', 'end': '2.59.223.253'}, {'start': '2.59.221.140', 'end': '2.59.221.254'}]",
          "has_delete_permission": false
        }
      ],
      "allowed_actions": [
        "add_subnet",
        "add_router"
      ],
      "name": "external_network",
      "description": "",
      "shared": true,
      "router_external": true,
      "is_default": false,
      "status": "ACTIVE",
      "admin_state_up": true,
      "created_at": "2022-02-11T20:19:57Z",
      "updated_at": "2023-07-13T19:41:33Z",
      "region": "ua-central-1",
      "project": "c712e3d141fa4a20b393320ac2bd1065"
    }
  ],
  "totalCount": 2,
  "pageNo": "1",
  "permissions": {
    "networks.list": true,
    "networks.retrieve": true,
    "networks.create": true,
    "networks.destroy": true,
    "networks.auto_create_network": true,
    "networks.update": true,
    "networks.save_auto_create_network_options": true
  }
}

409

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "string"
}

Example

{
  "detail": "Your client has no active OpenStack project"
}

Loading...