Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Cloud Interconnect API, gRPC: PrivateConnectionService.BatchGet

Written by
Updated at May 29, 2026

Get list of PrivateConnections by their IDs

gRPC request

rpc BatchGet (BatchGetPrivateConnectionsRequest) returns (BatchGetPrivateConnectionsResponse)

BatchGetPrivateConnectionsRequest

{
  "private_connection_ids": [
    "string"
  ]
}

Field

Description

private_connection_ids[]

string

List of IDs of the PrivateConnection resources to return.

BatchGetPrivateConnectionsResponse

{
  "private_connections": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "folder_id": "string",
      "trunk_connection_id": "string",
      "vlan_id": "google.protobuf.Int64Value",
      "ipv4_peering": {
        "peering_subnet": "string",
        "peer_ip": "string",
        "cloud_ip": "string",
        "peer_bgp_asn": "int64",
        "cloud_bgp_asn": "int64",
        "peer_bgp_md5_key": "string"
      },
      "ipv4_static_routes": [
        {
          "prefix": "string"
        }
      ],
      "labels": "map<string, string>",
      "status": "Status",
      "created_at": "google.protobuf.Timestamp"
    }
  ]
}

Field

Description

private_connections[]

PrivateConnection

List of PrivateConnections

PrivateConnection

A PrivateConnection resource.

Field

Description

id

string

ID of the privateConnection.

name

string

Name of the privateConnection.
The name must be unique within the folder.
Value must match the regular expression ``\

a-zA-Z?``.

description

string

Description of the privateConnection. 0-256 characters long.

folder_id

string

ID of the folder that the privateConnection belongs to.

trunk_connection_id

string

ID of the trunk_connection that the privateConnection belongs to.

vlan_id

google.protobuf.Int64Value

VLAN_ID that the privateConnection uses in multiplexing.
Not used in connections over partners-II
Value range: [1, 4095]

ipv4_peering

Peering

IPv4 peering config of connection

ipv4_static_routes[]

StaticRoute

IPv4 StaticRoute config of connection

labels

object (map<string, string>)

Resource labels, key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_0-9a-z]*.

status

enum Status

Status of the privateConnection.

  • CREATING
  • UPDATING
  • DELETING
  • ACTIVE

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

Peering

Field

Description

peering_subnet

string

PeeringSubnet.
It's an ip with format ipPrefix/length where address part of ipPrefix is 0.

The maximum string length in characters is 50.

peer_ip

string

PeerIp.
It's an ip with just an ipAddress format without mask.

The maximum string length in characters is 50.

cloud_ip

string

CloudIp.
It's an ip with just an ipAddress format without mask.

The maximum string length in characters is 50.

peer_bgp_asn

int64

PeerBgpAsn.
PeerAsn excluding rfc5398 (excluding 64496 - 64511 and 65536 - 65551).

cloud_bgp_asn

int64

CloudBgpAsn.

peer_bgp_md5_key

string

PeerBgpMd5Key.
Optional.

The maximum string length in characters is 200.

StaticRoute

Field

Description

prefix

string

Prefix.
It's an ip with format ipPrefix/length where address part of ipPrefix is 0.
Previous
RemoveStaticRoute
Next
Overview