Skip to main content

Attach VPC

POST/api/v1/vpc/node/attach/

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
    • non-empty string
    example{{api_key}}
  • locationQuerystringoptional

    The target location or region for the VPC attachment.

    • must be a non-empty string
    • should match a valid cloud region identifier (e.g., us-east-1)
    example{{location}}

Request body

application/json

string

JSON string containing parameters to attach a VPC

example{ "network_id": "{{network_id}}", "vpc_name": "VPC-493", "current_private_ip": {{private_ip}}, "node_id": {{node_id}}, "subnet_id": "{{subnet_id}}", "input_ip": {{preffered_ip}}, "action": "attach" }
  • must be a valid JSON object with keys: network_id, vpc_name, current_private_ip, node_id, subnet_id, input_ip, action
  • action field must be set to "attach"

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the attach VPC operation

example200
  • integer
  • value between 100 and 599
dataobject
errorsobject
messagestring

Human-readable status message for the Attach VPC operation

exampleVPC Attach operation successfully done
  • must be a non-empty string
  • maximum length of 255 characters