Skip to main content

VPC Details

GET/api/v1/vpc/node/{node_id}/

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the request

    • required
    • must be a non-empty string
    example{{api_key}}
  • locationQuerystringoptional

    Location identifier to filter VPC details

    • Required
    • Must be a valid region code (e.g., us-east-1)
    example{{location}}

Responses

200Successful response
object
is_private_cluster_userboolean

Indicates whether the user is a private cluster user

examplefalse
  • must be a boolean value
dnsstring

Space-separated list of DNS server IP addresses

example8.8.8.8 8.8.4.4
  • must be a space-separated list of IPv4 addresses
  • each address must be a valid IPv4 address
ipv4_cidrstring

IPv4 CIDR block of the VPC

example10.2.3.4/23
  • must be a valid IPv4 CIDR notation
  • must represent a network address (host bits zero)
namestring

Identifier of the VPC

exampleVPC-493
  • Must be a non-empty string
  • May contain alphanumeric characters and hyphens
  • Maximum length 64 characters
network_idinteger

Unique identifier of the VPC network

example12345
  • integer
  • positive
project_idstring

Identifier of the project associated with the VPC

example12345
  • non-empty string
  • contains only digits
subnet_idinteger

Identifier of the subnet

example123
  • required
  • positive integer
subnet_namestring

Name of the subnet

exampleapi-automation-subnet-2008
  • must be a non-empty string
  • may contain letters, numbers, and hyphens