Get Network

Get Network

Retrieve a network

Request
URI
GET
https://{api_host}/network-service//api/networks/{id}
COPY
Path Parameters
string
id
Required

Network ID

Responses
200

Successfully returned network

Returns Network of type(s) */* 
{
    "networkBackings": [
        {
            "computeResourceName": "string",
            "externalId": "string",
            "id": "string",
            "computeResourceNetworkId": "string",
            "computeResourceId": "string",
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ],
    "machineIdCollection": [
        "string"
    ],
    "name": "string",
    "tenantId": "string",
    "description": "string",
    "externalId": "string",
    "networkTypeId": "string",
    "networkProfileType": "string",
    "id": "string",
    "natRules": [
        {
            "networkInterfaceId": "string",
            "translatedAddress": "string",
            "componentId": "string",
            "userDefined": false,
            "externalId": "string",
            "description": "string",
            "targetType": "string",
            "type": "string",
            "enabled": false,
            "protocol": "string",
            "edgeId": "string",
            "machineId": "string",
            "originalAddress": "string",
            "name": "string",
            "peerInterfaceIndex": 0,
            "action": "string",
            "translatedPort": "string",
            "interfaceIndex": 0,
            "id": "string",
            "tag": "string",
            "componentName": "string",
            "order": 0,
            "originalPort": "string"
        }
    ],
    "extensionData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    }
}
array of NetworkBacking
networkBackings
Optional

networkBackings

array of string
machineIdCollection
Optional

machineIdCollection

string
name
Optional

name

string
tenantId
Optional

tenantId

string
description
Optional

description

string
externalId
Optional

externalId

string
networkTypeId
Optional

networkTypeId

string
networkProfileType
Required

networkProfileType

Possible values are : NONE, EXTERNAL, PRIVATE, NAT, ROUTED,
string
id
Optional

id

array of NatRule
natRules
Optional

natRules

literalMap
extensionData
Required

extensionData


404

Network not found with the provided id

Operation doesn't return any data structure

On This Page
Network Component Operations
POST
Add A list Of security policies To An on-demand security group
POST
Apply To Machine Security Tags
POST
Assign the security group To the specified machine(s)
POST
Create Network
POST
Create Security Group
DELETE
Delete Network
DELETE
Delete Security Group
GET
Get Load Balancer
GET
Get Network
GET
Get Security Group
GET
Get Security Policy
GET
Get Security Tags
GET
List Load Balancers
GET
List Networks
GET
List Security Groups
GET
List Security Groups For Tenant
GET
List Security Policy
GET
List Security Policy For Tenant
GET
List Security Tags
GET
List Security Tags For Tenant
PUT
Update Security Group
PUT
Update Security Policy
PUT
Update Security Tag