Contact UsGet started

Cloud Interconnect API, REST: PublicConnection.Get

Written by
Improved by
Updated at April 24, 2025

Returns the specified PublicConnection resource.

To get the list of available PublicConnection resources, make a List request.

HTTP request

GET https://cic.api.cloud.yandex.net/cic/v1/publicConnections/{publicConnectionId}

Path parameters

Field

Description

publicConnectionId

string

Required field. ID of the PublicConnection resource to return.
To get the publicConnection ID use a PublicConnectionService.List request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "name": "string",
  "description": "string",
  "folderId": "string",
  "regionId": "string",
  "trunkConnectionId": "string",
  "vlanId": "string",
  "ipv4Peering": {
    "peeringSubnet": "string",
    "peerIp": "string",
    "cloudIp": "string",
    "peerBgpAsn": "string",
    "cloudBgpAsn": "string",
    "peerBgpMd5Key": "string"
  },
  "ipv4AllowedServiceTypes": [
    "string"
  ],
  "ipv4PeerAnnouncedPrefixes": [
    "string"
  ],
  "labels": "object",
  "status": "string",
  "createdAt": "string"
}

A PublicConnection resource.

Field

Description

id

string

ID of the publicConnection.

name

string

Name of the publicConnection.
The name must be unique within the folder.
Value must match the regular expression \\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Optional description of the publicConnection. 0-256 characters long.

folderId

string

ID of the folder that the publicConnection belongs to.

regionId

string

ID of the region that the publicConnection belongs to.

trunkConnectionId

string

ID of the trunk_connection that the publicConnection belongs to.

vlanId

string (int64)

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

ipv4Peering

Peering

IPv4 peering config of connection

ipv4AllowedServiceTypes[]

enum (CloudServiceType)

Cloud services that the publicConnection connects to.

  • CLOUD_SERVICE_TYPE_UNSPECIFIED
  • CLOUD_SERVICE_YANDEX
  • CLOUD_SERVICE_ALL_PUBLIC
  • CLOUD_SERVICE_S3
  • CLOUD_SERVICE_ML
  • CLOUD_SERVICE_APIGW
  • CLOUD_SERVICE_CONTAINER_REGISTRY
  • CLOUD_SERVICE_CONSOLE
  • CLOUD_SERVICE_MONITORING
  • CLOUD_SERVICE_YANDEX_GPT
  • CLOUD_SERVICES_ALL_API_ENDPOINT
  • CLOUD_SERVICE_YMQ

ipv4PeerAnnouncedPrefixes[]

string

IPv4 Peer Announced Prefixes
It's an list of ip with format ipPrefix/length where address part of ipPrefix is 0

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 publicConnection.

  • STATUS_UNSPECIFIED
  • CREATING
  • UPDATING
  • DELETING
  • ACTIVE

createdAt

string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Peering

Field

Description

peeringSubnet

string

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

peerIp

string

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

cloudIp

string

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

peerBgpAsn

string (int64)

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

cloudBgpAsn

string (int64)

CloudBgpAsn.

peerBgpMd5Key

string

PeerBgpMd5Key.
Optional.
Previous
Overview
Next
List