Sign in
Peerings (networking/v1)

List of Peerings

General Availability

Retrieve a sorted, filtered, paginated list of all peerings.

get/networking/v1/peerings

Query parameters

spec.display_namestring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values.

status.phasestring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values.

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

spec.networkstring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Peering.

api_version'networking/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'PeeringList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/networking/v1/peerings",
    "last": "https://api.confluent.cloud/networking/v1/peerings?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/networking/v1/peerings?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/networking/v1/peerings?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/networking/v1/peerings/p-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/peering=p-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "spec": {
        "display_name": "prod-peering-use1",
        "cloud": {
          "account": "000000000000",
          "vpc": "vpc-00000000000000000",
          "routes": [
            "10.108.16.0/21"
          ],
          "customer_region": "us-east-1"
        },
        "environment": {
          "id": "env-00000",
          "related": "https://api.confluent.cloud/v2/environments/env-00000",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
        },
        "network": {
          "id": "n-00000",
          "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000"
        }
      },
      "status": {
        "phase": "READY"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.