Update Network Pool

Update Network Pool

Update a Network Pool by ID, if it exists

Request
URI
PATCH
https://{api_host}/v1/network-pools/{id}
COPY
Path Parameters
string
id
Required

Network Pool ID


Request Body
NetworkPoolUpdateSpec of type(s) application/json
Required
{
    "name": "string"
}
string
name
Required
Constraints: minLength: 3 maxLength: 80

Name of the Network Pool

Responses
200

Network Pool update completed

Returns NetworkPool of type(s) application/json
"NetworkPool Object"
string
id
Optional

The ID of the network pool

string
name
Required

User specified name of the network pool

array of object
networks
Required

Representing the networks associated with the network pool

integer As int32 As int32
hostsCount
Optional

Number of hosts connected to the network pool


404

Network Pool not found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

Unexpected error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'