​

ves-io-schema-views-terraform_parameters-CustomAPI-Get

Published April 5, 2023 | Last modified September 15, 2026

Examples of performing terraform_parameters CustomAPI Get

Usecase:

Perform Get on terraform_parameters

Request:

Request using vesctl:

vesctl request rpc terraform_parameters.CustomAPI.Get -i request.yaml --uri /public/namespaces/namespace-literal/terraform_parameters/view_kind-literal/view_name-literal --http-method GET

where file request.yaml has following contents:

{}

vesctl yaml response:

terraformParameters:
  creds: []
  tfObjects:
  - '@type': type.googleapis.com/ves.io.schema.views.terraform_parameters.AWSVPCType
    masterNodes:
    - publicSubnetId: ves-io-subnet-1234
    siteName: site-1
    subnets:
    - subnet:
        existingSubnetId: ves-io-subner-1234
      voltSubnetId: ves-io-subnet-1234
      voltVpcId: ves-vpc-id-1234
    voltVpcId: ves-vpc-id-1234
    vpc:
      vpcId: vpc-1234
    workerNodes: 5

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/namespace-literal/terraform_parameters/view_kind-literal/view_name-literal?namespace=&view_kind=&view_name='

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 19 Jun 2026 22:14:26 GMT
Vary: Accept-Encoding


{
  "terraform_parameters": {
    "tf_objects": [
      {
        "@type": "type.googleapis.com/ves.io.schema.views.terraform_parameters.AWSVPCType",
        "site_name": "site-1",
        "aws_name": "",
        "volt_vpc_id": "ves-vpc-id-1234",
        "certified_hw": "",
        "vpc": {
          "new_vpc": null,
          "vpc_id": "vpc-1234"
        },
        "subnets": [
          {
            "volt_subnet_id": "ves-io-subnet-1234",
            "volt_vpc_id": "ves-vpc-id-1234",
            "az": "",
            "subnet": {
              "subnet_param": null,
              "existing_subnet_id": "ves-io-subner-1234"
            },
            "interface_type": "INTERFACE_INSIDE"
          }
        ],
        "master_nodes": [
          {
            "volt_node_id": "",
            "volt_vpc_id": "",
            "public_subnet_id": "ves-io-subnet-1234",
            "private_subnet_id": "",
            "instance_type": "",
            "disk_size": "",
            "encryption": false,
            "kms_key": "",
            "ami_id": "",
            "node_count": 0,
            "ebs_volume_size": 0,
            "ebs_volume_az": ""
          }
        ],
        "inside_vip_port_config": [
        ],
        "outside_vip_port_config": [
        ],
        "worker_nodes": 5,
        "gateway_type": "INGRESS_GATEWAY",
        "aws_region": "",
        "ssh_key": "",
        "admin_password": "",
        "admin_password_clear_b64": "",
        "admin_password_blindfolded": "",
        "tags": {
        },
        "dx_connect": null,
        "multi_node_non_std_az": false,
        "internet_vip": false,
        "deployment": null,
        "egress_gw_id": "",
        "assume_role": null,
        "outside_security_group_id": "",
        "inside_security_group_id": "",
        "disable_internet_connectivity_via_igw": false,
        "manual_routing": false,
        "use_launch_templates": false
      }
    ],
    "creds": [
    ],
    "container_version": ""
  }
}
On this page: