Update Network Profile

Update Network Profile

Update network profile

Request
URI
PATCH
https://{api_host}/iaas/api/network-profiles/{id}
COPY
Path Parameters
string
id
Required

The ID of the network profile.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Request Body

NetworkProfile specification

NetworkProfileSpecification of type(s) application/json
Required
{
    "name": "string",
    "description": "string",
    "fabricNetworkIds": [
        "string"
    ],
    "securityGroupIds": [
        "string"
    ],
    "regionId": "9e49",
    "isolationType": "SUBNET",
    "isolationNetworkDomainId": "1234",
    "isolationNetworkDomainCIDR": "10.10.10.0/24",
    "isolationExternalFabricNetworkId": "1234",
    "isolatedNetworkCIDRPrefix": 24,
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

array of string
fabricNetworkIds
Optional

A list of fabric network Ids which are assigned to the network profile.

array of string
securityGroupIds
Optional

A list of security group Ids which are assigned to the network profile.

string
regionId
Required

The Id of the region for which this profile is created

string
isolationType
Optional

Specifies the isolation type e.g. none, subnet or security group

Possible values are : NONE, SUBNET, SECURITY_GROUP,
string
isolationNetworkDomainId
Optional

The Id of the network domain used for creating isolated networks.

string
isolationNetworkDomainCIDR
Optional

CIDR of the isolation network domain.

string
isolationExternalFabricNetworkId
Optional

The Id of the fabric network used for outbound access.

integer As int32 As int32
isolatedNetworkCIDRPrefix
Optional

The CIDR prefix length to be used for the isolated networks that are created with the network profile.

array of Tag
tags
Optional

A set of tag keys and optional values that should be set on any resource that is produced from this specification.

object
customProperties
Optional

Additional properties that may be used to extend the Network Profile object that is produced from this specification.

Responses
200

successful operation

Returns NetworkProfile of type(s) application/json
{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "externalRegionId": "us-east-1",
    "isolationType": "string",
    "isolationNetworkDomainCIDR": "string",
    "isolatedNetworkCIDRPrefix": 0,
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user that owns the entity.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
externalRegionId
Optional

The id of the region for which this profile is defined

string
isolationType
Optional

Specifies the isolation type e.g. none, subnet or security group

Possible values are : NONE, SUBNET, SECURITY_GROUP,
string
isolationNetworkDomainCIDR
Optional

CIDR of the isolation network domain.

integer As int32 As int32
isolatedNetworkCIDRPrefix
Optional

The CIDR prefix length to be used for the isolated networks that are created with the network profile.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on this Network Profile.

object
customProperties
Optional

Additional properties that may be used to extend the Network Profile object.


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure