Sign in
Access Points (networking/v1)

List of Access Points

General Availability

Retrieve a sorted, filtered, paginated list of all access points.

get/networking/v1/access-points

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.

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

spec.gatewaystring[]

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

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

idstring[]

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

Filter the results by exact match for id. 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

Access Point.

api_version'networking/v1' required

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

kind'AccessPointList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/networking/v1/access-points",
    "last": "https://api.confluent.cloud/networking/v1/access-points?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/networking/v1/access-points?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/networking/v1/access-points?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/networking/v1/access-points/ap-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-456xyz/access-point=ap-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-ap-egress-usw2",
        "config": {
          "vpc_endpoint_service_name": "com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000",
          "target_system": "S3"
        },
        "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"
        },
        "gateway": {
          "id": "gw-00000",
          "related": "https://api.confluent.cloud/networking/v1/gateways/gw-00000",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/gateway=gw-00000"
        }
      },
      "status": {
        "phase": "READY",
        "config": {
          "vpc_endpoint_id": "vpce-00000000000000000",
          "vpc_endpoint_dns_name": "vpce-00000000000000000-00000000.vpce-svc-00000000000000000.us-west-2.vpce.amazonaws.com"
        }
      }
    }
  ]
}

Changes

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