> ## Documentation Index > Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt > Use this file to discover all available pages before exploring further. # List Site2cloud conn > Retrieve list Site2cloud conn. ## OpenAPI ````yaml /openapi/9.0/aviatrix-api.json get /v2/api/list_site2cloud_conn openapi: 3.1.0 info: title: Aviatrix Controller API version: '9.0' description: >- Aviatrix Controller API — version 9.0. Selected operations with Mintlify metadata. servers: [] security: [] tags: - name: policies x-group: Policies - name: authentication x-group: Authentication - name: account-management x-group: Account Management - name: rbac x-group: RBAC & Permissions - name: gateways x-group: Gateways - name: transit x-group: Transit - name: nat x-group: NAT - name: app-domains x-group: SmartGroups - name: certificates x-group: Certificates - name: mitm x-group: MITM - name: monitoring x-group: Monitoring & Diagnostics - name: fqdn x-group: FQDN - name: logging x-group: Logging - name: vpn x-group: UserVPN - name: site-to-cloud x-group: Site-to-Cloud - name: controller x-group: Controller - name: bgp x-group: BGP - name: general x-group: General - name: firenet x-group: FireNet - name: networking x-group: Networking - name: tgw x-group: AWS TGW - name: ips x-group: IPS - name: saml x-group: SAML paths: /v2/api/list_site2cloud_conn: get: tags: - site-to-cloud operationId: list_site2cloud_conn_get parameters: - description: VPC id. in: query name: vpc_id required: false schema: type: string - description: Connection name. in: query name: name required: false schema: type: string - description: Command from transit network page. in: query name: from_transit_spoke required: false schema: type: boolean - description: Gateway name. in: query name: gw_name required: false schema: type: string - description: Public IP address of the Peer gateway. in: query name: peer_ip required: false schema: type: string - description: Geo location of the Peer gateway. in: query name: peer_geo_info required: false schema: type: string - description: Peer gateway type. in: query name: peer_type required: false schema: type: string - description: Remote site CIDR. in: query name: remote_cidr required: false schema: type: string - description: DPD config. in: query name: dpd_config required: false schema: enum: - disable - enable type: string - description: DPD delay. in: query name: dpd_delay required: false schema: type: string - description: DPD retry. in: query name: dpd_retry required: false schema: type: string - description: DPD maxfail. in: query name: dpd_maxfail required: false schema: type: string - description: Enable private route encryption. in: query name: private_route_encr required: false schema: type: boolean - description: Cloud subnet cidr. in: query name: cloud_subnet_cidr required: false schema: type: string - description: Overlapping customer and cloud networks. in: query name: netmap required: false schema: type: boolean - description: Remote site virtual subnet. in: query name: remote_virt_subnet required: false schema: type: string - description: Cloud virtual subnet. in: query name: cloud_virt_subnet required: false schema: type: string - description: Pre-shared key. in: query name: psk required: false schema: type: string - description: Backup Pre-shared key. in: query name: psk_backup required: false schema: type: string - description: Same backup pre-shared key. in: query name: same_backup_psk required: false schema: type: boolean - description: 'Auth type: pubkey or psk.' in: query name: auth_type required: false schema: type: string - description: Remote identifier for IKE config in primary gateway. in: query name: cert_based_s2c_remote_id required: false schema: type: string - description: Remote identifier for IKE config in HA gateway. in: query name: cert_based_s2c_ha_remote_id required: false schema: type: string - description: Remote CA cert name for cert based S2C. in: query name: s2c_cacert_tag_name required: false schema: type: string - description: Enable HA. in: query name: enable_ha required: false schema: type: boolean - description: Enable single public IP HA. in: query name: single_ip_ha required: false schema: type: boolean - description: Enable IKEv2. in: query name: enable_ikev2 required: false schema: type: boolean - description: Route Tables List. in: query name: rtbs_list required: false schema: type: string - description: Phase 1 encryption algorithm. in: query name: ph1_encr required: false schema: type: string - description: Phase 1 authentication algorithm. in: query name: ph1_auth required: false schema: type: string - description: Phase 1 DH group. in: query name: ph1_dh required: false schema: type: string - description: Phase 2 encryption algorithm. in: query name: ph2_encr required: false schema: type: string - description: Phase 2 authentication algorithm. in: query name: ph2_auth required: false schema: type: string - description: Phase 2 DH group. in: query name: ph2_dh required: false schema: type: string - description: Select route based tunnel type. in: query name: route_based required: false schema: type: boolean - description: BGP local ip address. in: query name: bgp_local_ip required: false schema: type: string - description: BGP remote ip address. in: query name: bgp_remote_ip required: false schema: type: string - description: BGP backup local ip addr. in: query name: bgp_backup_local_ip required: false schema: type: string - description: BGP backup remote ip addr. in: query name: bgp_backup_remote_ip required: false schema: type: string - description: Select UDP. in: query name: proto required: false schema: enum: - udp type: string - description: Opvn_file for client. in: query name: ovpn required: false schema: type: string - description: Server pool for SSL, e.g. 192.168.0.0/16. in: query name: ssl_server_pool required: false schema: type: string - description: Saves the template. in: query name: save_template required: false schema: type: boolean - description: Source IP of tunnel. in: query name: local_ip required: false schema: type: string - description: Source IP of tunnel. in: query name: local_ip_backup required: false schema: type: string - description: . in: query name: tunnel_address_local required: false schema: type: string - description: . in: query name: tunnel_address_remote required: false schema: type: string - description: . in: query name: tunnel_address_local_backup required: false schema: type: string - description: . in: query name: tunnel_address_remote_backup required: false schema: type: string - description: . in: query name: remote_peer_backup_private_ip required: false schema: type: string - description: . in: query name: enable_lb_primary required: false schema: type: boolean - description: . in: query name: enable_global_accelerator required: false schema: type: string - description: . in: query name: active_active required: false schema: enum: - disable - enable type: string - description: . in: query name: event_triggered_ha required: false schema: enum: - disable - enable type: string - description: . in: query name: natt required: false schema: enum: - disable - enable type: string - description: . in: query name: phase1_identifier required: false schema: enum: - private_ip - public_ip type: string - description: Phase 1 remote identification. in: query name: phase1_remote_id required: false schema: type: string - description: Running vti policy. in: query name: vti_policy required: false schema: type: boolean - description: . in: query name: forward_to_transit required: false schema: enum: - disable - enable type: string - description: . in: query name: proxy_id required: false schema: enum: - disable - enable type: string - description: . in: query name: custom_map required: false schema: type: boolean - description: Remote source real cidrs. in: query name: remote_src_real_cidrs required: false schema: type: string - description: Remote source virtual cidrs. in: query name: remote_src_virt_cidrs required: false schema: type: string - description: Remote destination real cidrs. in: query name: remote_dst_real_cidrs required: false schema: type: string - description: Remote destination virtual cidrs. in: query name: remote_dst_virt_cidrs required: false schema: type: string - description: Local source real cidrs. in: query name: local_src_real_cidrs required: false schema: type: string - description: Local source virtual cidrs. in: query name: local_src_virt_cidrs required: false schema: type: string - description: Local destination real cidrs. in: query name: local_dst_real_cidrs required: false schema: type: string - description: Local destination virtual cidrs. in: query name: local_dst_virt_cidrs required: false schema: type: string - description: Clear connection tracking table entries. in: query name: clear_conntrack required: false schema: type: boolean - description: Enable/Disable jumbo frame support. in: query name: jumbo_frame required: false schema: enum: - disable - enable type: string - description: Show detailed info. in: query name: tunnel_detail required: false schema: type: boolean - description: Show connections in this VPC. in: query name: show_connections required: false schema: type: boolean - description: Show gateways in this connection. in: query name: show_gateways required: false schema: type: boolean - description: Show detailed connection info. in: query name: details required: false schema: type: boolean - description: Show supported algorithms. in: query name: algorithms required: false schema: type: boolean - description: Show transit VPC connections only. in: query name: transit_only required: false schema: type: boolean - description: Show Cloud WAN connections only. in: query name: cloudwan_only required: false schema: type: boolean - description: Show PSK only. in: query name: key_only required: false schema: type: boolean - description: Show transit BGP VPC connections only. in: query name: bgp_only required: false schema: type: boolean - description: Connection configuration. in: query name: cfg_file required: false schema: type: string - $ref: '#/components/parameters/action' - $ref: '#/components/parameters/CID' responses: '200': $ref: '#/components/responses/general_response_v2' default: $ref: '#/components/responses/general_response_v2' x-codeSamples: - lang: curl label: cURL source: |- curl -sk -X GET "https:///v2/api/list_site2cloud_conn" \ -H "Authorization: cid " - lang: python label: Python source: |- import requests url = "https:///v2/api/list_site2cloud_conn" headers = {"Authorization": "cid "} response = requests.get(url, headers=headers, verify=False) print(response.status_code) print(response.text) - lang: javascript label: JavaScript source: |- fetch("https:///v2/api/list_site2cloud_conn", { method: "GET", headers: {"Authorization": "cid "} }) .then(res => res.text()) .then(console.log) .catch(console.error); - lang: go label: Go source: |- package main import ( "fmt" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https:///v2/api/list_site2cloud_conn", nil) req.Header.Set("Authorization", "cid ") client := &http.Client{} resp, err := client.Do(req) if err != nil { panic(err) } defer resp.Body.Close() fmt.Println(resp.Status) } components: parameters: action: description: The API action to perform. Required for 7.2 controllers only. in: query name: action schema: $ref: '#/components/schemas/action' CID: description: The opaque session ID token. Required for 7.2 controllers only. in: query name: CID schema: $ref: '#/components/schemas/CID' responses: general_response_v2: content: application/json: schema: $ref: '#/components/schemas/general_response_v2' description: General v2 API response schema. schemas: action: description: The API action to perform. Required for 7.2 controllers only. type: string CID: description: The opaque session ID token. Required for 7.2 controllers only. type: string general_response_v2: additionalProperties: true description: A generic API response container for v2 style APIs. properties: errortype: description: Error type if the API failed. type: string reason: description: Failure reason if the API failed. type: string results: oneOf: - description: API response data type: boolean - description: API response data type: integer - description: API response data type: string - description: API response data type: object - description: API response data items: {} type: array return: description: Whether the API returned successfully type: boolean title: General Response v2 type: object ````