Skip to content
API Enriched

Configure AWS VPC Site Information.

POST
/api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_cloud_site_info
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/aws_vpc_site/example/set_cloud_site_info \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "aws_vpc_info": { "private_ips": [ "example" ], "public_ips": [ "example" ], "subnet_ids": [ { "az_name": "example", "inside_subnet": { "az_name": "example", "id": "example", "ipv4_prefix": "example" }, "inside_subnet_id": "example", "outside_subnet": { "az_name": "example", "id": "example", "ipv4_prefix": "example" }, "outside_subnet_id": "example", "workload_subnet": { "az_name": "example", "id": "example", "ipv4_prefix": "example" }, "workload_subnet_id": "example" } ], "vpc_id": "example", "vpc_name": "example" }, "direct_connect_info": { "asn": 1, "direct_connect_gateway_id": "example", "vgw_id": "example" }, "name": "example", "namespace": "example" }'

Configure AWS VPC Site Information like public, private ips, subnet IDs and others.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace for the object to be configured.

name
required
string

Name Name of the object to be configured.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Request to configure Cloud Site Information

Request to configure Cloud Site Information.

object
aws_vpc_info
object
private_ips
AWS Node Private IPs

AWS Private IPs used by the nodes Required: YES.

Array<string>
public_ips
AWS Node Elastic IPs

AWS Elastic IPs used by the nodes Required: YES.

Array<string>
subnet_ids
AWS Subnet Info

AWS Subnet Info where the F5XC site is deployed

Required: YES.

Array<object>
AWS Subnets Ids

AWS Subnet IDs used by F5 Distributed Cloud site.

object
az_name
AZ Name

AWS availability zone, must be consistent with the selected AWS region.

string
<= 1024 characters
inside_subnet
object
az_name
AZ Name

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string
<= 1024 characters
id
Subnet ID

Subnet ID

string
>= 1 <= 4094 <= 64 characters
ipv4_prefix
Subnet CIDR block

Subnet CIDR block. It has to be private address space. Required: YES.

string
<= 1024 characters
inside_subnet_id
Inside Subnet ID

Inside subnet ID used by F5 Distributed Cloud site.

string
<= 1024 characters
outside_subnet
object
az_name
AZ Name

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string
<= 1024 characters
id
Subnet ID

Subnet ID

string
>= 1 <= 4094 <= 64 characters
ipv4_prefix
Subnet CIDR block

Subnet CIDR block. It has to be private address space. Required: YES.

string
<= 1024 characters
outside_subnet_id
Outside Subnet ID

Outside subnet ID used by F5 Distributed Cloud site.

string
<= 1024 characters
workload_subnet
object
az_name
AZ Name

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string
<= 1024 characters
id
Subnet ID

Subnet ID

string
>= 1 <= 4094 <= 64 characters
ipv4_prefix
Subnet CIDR block

Subnet CIDR block. It has to be private address space. Required: YES.

string
<= 1024 characters
workload_subnet_id
Workload Subnet ID

Workload subnet ID used by F5 Distributed Cloud site.

string
<= 1024 characters
vpc_id
VPC ID

VPC ID where the F5 Distributed Cloud site exists.

string
<= 1024 characters
vpc_name
VPC Name

VPC Name where the F5 Distributed Cloud site exists.

string
<= 1024 characters
direct_connect_info
object
asn
AWS Side ASN

The autonomous system (AS) number on the AWS side for Border Gateway Protocol (BGP) configuration.

integer format: int64
direct_connect_gateway_id
DirectConnect Gateway ID

DirectConnect Gateway ID Required: YES.

string
<= 1024 characters
vgw_id
Virtual Private Gateway ID

Virtual Private Gateway ID Required: YES.

string
<= 1024 characters
name
Name

Name of the object to be configured.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Namespace for the object to be configured.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
  "aws_vpc_info": {
    "private_ips": [
      "example"
    ],
    "public_ips": [
      "example"
    ],
    "subnet_ids": [
      {
        "az_name": "example",
        "inside_subnet": {
          "az_name": "example",
          "id": "example",
          "ipv4_prefix": "example"
        },
        "inside_subnet_id": "example",
        "outside_subnet": {
          "az_name": "example",
          "id": "example",
          "ipv4_prefix": "example"
        },
        "outside_subnet_id": "example",
        "workload_subnet": {
          "az_name": "example",
          "id": "example",
          "ipv4_prefix": "example"
        },
        "workload_subnet_id": "example"
      }
    ],
    "vpc_id": "example",
    "vpc_name": "example"
  },
  "direct_connect_info": {
    "asn": 1,
    "direct_connect_gateway_id": "example",
    "vgw_id": "example"
  },
  "name": "example",
  "namespace": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Response to configure Cloud Site Information

Response to configure configure Cloud Site Information.

object
Examplegenerated
{}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example