---
title: "Update an Access Point"
method: PATCH
path: "/networking/v1/access-points/{id}"
tags: ["Access Points (networking/v1)"]
---
# Update an Access Point
`PATCH /networking/v1/access-points/{id}`
[](#section/Versioning/API-Lifecycle-Policy)
Make a request to update an access point.
## Path parameters
- `id` string, required
## Request body
- object — AccessPoint objects represent network connections in and out of Gateways. This API allows you to list, create, read, update, and delete your access points. ## The Access Points Model
- `api_version` 'networking/v1' — APIVersion defines the schema version of this representation of a resource.
- `kind` 'AccessPoint' — Kind defines the object this REST resource represents.
- `id` string — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
- `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
- `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
- `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
- `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
- `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
- `spec` object, required — The desired state of the Access Point
- `display_name` string — The name of the access point.
- `config` union — The specific details of the different access point configurations.
- object — AWS VPC Endpoint.
- `kind` 'AwsEgressPrivateLinkEndpoint', required — AwsEgressPrivateLinkEndpoint kind.
- `vpc_endpoint_service_name` string, required — ID of the VPC Endpoint service used for PrivateLink.
- `enable_high_availability` boolean — Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs.
- `target_system` string — [Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").
- object — AWS Ingress Private Link Endpoint.
- `kind` 'AwsIngressPrivateLinkEndpoint', required — AwsIngressPrivateLinkEndpoint kind.
- `vpc_endpoint_id` string, required — ID of a VPC Endpoint that will be connected to the VPC Endpoint service.
- object — Azure Private Endpoint.
- `kind` 'AzureEgressPrivateLinkEndpoint', required — AzureEgressPrivateLinkEndpoint kind.
- `private_link_service_resource_id` string, required — Resource ID of the Azure Private Link service.
- `private_link_subresource_name` string — Name of the subresource for the Private Endpoint to connect to.
- `target_system` string — [Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").
- object — Azure Ingress Private Link Endpoint.
- `kind` 'AzureIngressPrivateLinkEndpoint', required — AzureIngressPrivateLinkEndpoint kind.
- `private_endpoint_resource_id` string, required — Resource ID of a Private Endpoint that will be connected to the Private Link service.
- object — Confluent Private Network Interface powered by AWS ENI.
- `kind` 'AwsPrivateNetworkInterface', required — AwsPrivateNetworkInterface kind.
- `network_interfaces` string[] — List of the IDs of the Elastic Network Interfaces.
- `account` string — The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface.
- `egress_routes` string[] — List of egress CIDRs (IPv4) for egress PNI.
- object — GCP Private Service Connect Endpoint.
- `kind` 'GcpEgressPrivateServiceConnectEndpoint', required — GcpEgressPrivateServiceConnectEndpoint kind.
- `private_service_connect_endpoint_target` string, required — URI of the service attachment for the published service that the Private Service Connect Endpoint connects to or "ALL_GOOGLE_APIS" for global Google APIs.
- `target_system` string — [Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "GCS" or "SNOWFLAKE").
- object — GCP Ingress Private Service Connect Endpoint.
- `kind` 'GcpIngressPrivateServiceConnectEndpoint', required — GcpIngressPrivateServiceConnectEndpoint kind.
- `private_service_connect_connection_id` string, required — The ID of the Private Service Connect connection.
- `environment` object, required — The environment to which this belongs.
- `id` string, required — ID of the referred resource
- `environment` string — Environment of the referred resource, if env-scoped
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `api_version` string — API group and version of the referred resource
- `kind` string — Kind of the referred resource
- `gateway` ObjectReference — ObjectReference provides information for you to locate the referred object
- `id` string, required — ID of the referred resource
- `environment` string — Environment of the referred resource, if env-scoped
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `api_version` string — API group and version of the referred resource
- `kind` string — Kind of the referred resource
- `status` NetworkingV1AccessPointStatus — The status of the Access Point
- `phase` string, required — The lifecycle phase of the access point: PROVISIONING: Access point provisioning is in progress; PENDING_ACCEPT: Access point connection request is pending acceptance by the customer; READY: Access point is ready; FAILED: Access point is in a failed state; DEPROVISIONING: Access point deprovisioning is in progress; DISCONNECTED: Access Point has been disconnected in the cloud provider by the customer; DEGRADED: Access Point is experiencing reduced performance or partial failure; ERROR: Invalid customer input during Access Point creation;
- `error_code` string — Error code if access point is in a failed state. May be used for programmatic error checking.
- `error_message` string — Displayable error message if access point is in a failed state.
- `config` union — Cloud specific status of the access point.
- object — Status of an AWS PrivateLink Endpoint.
- `kind` 'AwsEgressPrivateLinkEndpointStatus', required — AwsEgressPrivateLinkEndpointStatus kind.
- `vpc_endpoint_id` string, required — ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service.
- `vpc_endpoint_dns_name` string, required — DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service.
- object — Status of an AWS Ingress Private Link Endpoint.
- `kind` 'AwsIngressPrivateLinkEndpointStatus', required — AwsIngressPrivateLinkEndpointStatus kind.
- `vpc_endpoint_service_name` string, required — ID of the Confluent Cloud VPC Endpoint service used for PrivateLink.
- `vpc_endpoint_id` string, required — ID of the VPC Endpoint used for connecting to the VPC Endpoint service.
- `dns_domain` string — DNS domain name used to configure the Private Hosted Zone for the Access Point.
- object — Status of an Azure Private Endpoint.
- `kind` 'AzureEgressPrivateLinkEndpointStatus', required — AzureEgressPrivateLinkEndpointStatus kind.
- `private_endpoint_resource_id` string, required — Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
- `private_endpoint_domain` string — Domain of the Private Endpoint (if any) that is connected to the Private Link service.
- `private_endpoint_ip_address` string, required — IP address of the Private Endpoint (if any) that is connected to the Private Link service.
- `private_endpoint_custom_dns_config_domains` string[] — Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup.
- object — Status of an Azure Ingress Private Link Endpoint.
- `kind` 'AzureIngressPrivateLinkEndpointStatus', required — AzureIngressPrivateLinkEndpointStatus kind.
- `private_link_service_alias` string, required — Alias of the Confluent Cloud Private Link Service.
- `private_link_service_resource_id` string, required — Resource ID of the Confluent Cloud Private Link Service.
- `private_endpoint_resource_id` string, required — Resource ID of the Private Endpoint used for connecting to the Private Link Service.
- `dns_domain` string — DNS domain name used to configure the Private DNS Zone for the Access Point.
- object — Status of a GCP Private Service Connect Endpoint.
- `kind` 'GcpEgressPrivateServiceConnectEndpointStatus', required — GcpEgressPrivateServiceConnectEndpointStatus kind.
- `private_service_connect_endpoint_connection_id` string, required — Connection ID of the Private Service Connect Endpoint (if any) that is connected to the endpoint target.
- `private_service_connect_endpoint_name` string, required — Name of the Private Service Connect Endpoint (if any) that is connected to the endpoint target.
- `private_service_connect_endpoint_ip_address` string, required — IP address of the Private Service Connect Endpoint (if any) that is connected to the endpoint target.
- object — Status of a GCP Ingress Private Service Connect Endpoint.
- `kind` 'GcpIngressPrivateServiceConnectEndpointStatus', required — GcpIngressPrivateServiceConnectEndpointStatus kind.
- `private_service_connect_service_attachment` string, required — URI of the Private Service Connect Service Attachment in Confluent Cloud.
- `private_service_connect_connection_id` string, required — The ID of the Private Service Connect connection.
- `dns_domain` string — DNS domain name used to configure the DNS Zone for the Access Point.
## Response `200`
Access Point.
- object — AccessPoint objects represent network connections in and out of Gateways. This API allows you to list, create, read, update, and delete your access points. ## The Access Points Model
- `api_version` 'networking/v1', required — APIVersion defines the schema version of this representation of a resource.
- `kind` 'AccessPoint', required — Kind defines the object this REST resource represents.
- `id` string, required — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
- `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
- `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
- `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
- `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
- `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
- `spec` object, required — The desired state of the Access Point
- `display_name` string — The name of the access point.
- `config` union, required — The specific details of the different access point configurations.
- object — AWS VPC Endpoint.
- `kind` 'AwsEgressPrivateLinkEndpoint', required — AwsEgressPrivateLinkEndpoint kind.
- `vpc_endpoint_service_name` string, required — ID of the VPC Endpoint service used for PrivateLink.
- `enable_high_availability` boolean — Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs.
- `target_system` string — [Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").
- object — AWS Ingress Private Link Endpoint.
- `kind` 'AwsIngressPrivateLinkEndpoint', required — AwsIngressPrivateLinkEndpoint kind.
- `vpc_endpoint_id` string, required — ID of a VPC Endpoint that will be connected to the VPC Endpoint service.
- object — Azure Private Endpoint.
- `kind` 'AzureEgressPrivateLinkEndpoint', required — AzureEgressPrivateLinkEndpoint kind.
- `private_link_service_resource_id` string, required — Resource ID of the Azure Private Link service.
- `private_link_subresource_name` string — Name of the subresource for the Private Endpoint to connect to.
- `target_system` string — [Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "MONGODB" or "SNOWFLAKE").
- object — Azure Ingress Private Link Endpoint.
- `kind` 'AzureIngressPrivateLinkEndpoint', required — AzureIngressPrivateLinkEndpoint kind.
- `private_endpoint_resource_id` string, required — Resource ID of a Private Endpoint that will be connected to the Private Link service.
- object — Confluent Private Network Interface powered by AWS ENI.
- `kind` 'AwsPrivateNetworkInterface', required — AwsPrivateNetworkInterface kind.
- `network_interfaces` string[] — List of the IDs of the Elastic Network Interfaces.
- `account` string — The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface.
- `egress_routes` string[] — List of egress CIDRs (IPv4) for egress PNI.
- object — GCP Private Service Connect Endpoint.
- `kind` 'GcpEgressPrivateServiceConnectEndpoint', required — GcpEgressPrivateServiceConnectEndpoint kind.
- `private_service_connect_endpoint_target` string, required — URI of the service attachment for the published service that the Private Service Connect Endpoint connects to or "ALL_GOOGLE_APIS" for global Google APIs.
- `target_system` string — [Used by the Confluent Cloud Console] The target system or service that the PrivateLink Endpoint connects to (e.g. "GCS" or "SNOWFLAKE").
- object — GCP Ingress Private Service Connect Endpoint.
- `kind` 'GcpIngressPrivateServiceConnectEndpoint', required — GcpIngressPrivateServiceConnectEndpoint kind.
- `private_service_connect_connection_id` string, required — The ID of the Private Service Connect connection.
- `environment` object, required — The environment to which this belongs.
- `id` string, required — ID of the referred resource
- `environment` string — Environment of the referred resource, if env-scoped
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `api_version` string — API group and version of the referred resource
- `kind` string — Kind of the referred resource
- `gateway` object, required — The gateway to which this belongs.
- `id` string, required — ID of the referred resource
- `environment` string — Environment of the referred resource, if env-scoped
- `related` string, uri, required — API URL for accessing or modifying the referred object
- `resource_name` string, uri, required — CRN reference to the referred resource
- `api_version` string — API group and version of the referred resource
- `kind` string — Kind of the referred resource
- `status` NetworkingV1AccessPointStatus, required — The status of the Access Point
- `phase` string, required — The lifecycle phase of the access point: PROVISIONING: Access point provisioning is in progress; PENDING_ACCEPT: Access point connection request is pending acceptance by the customer; READY: Access point is ready; FAILED: Access point is in a failed state; DEPROVISIONING: Access point deprovisioning is in progress; DISCONNECTED: Access Point has been disconnected in the cloud provider by the customer; DEGRADED: Access Point is experiencing reduced performance or partial failure; ERROR: Invalid customer input during Access Point creation;
- `error_code` string — Error code if access point is in a failed state. May be used for programmatic error checking.
- `error_message` string — Displayable error message if access point is in a failed state.
- `config` union — Cloud specific status of the access point.
- object — Status of an AWS PrivateLink Endpoint.
- `kind` 'AwsEgressPrivateLinkEndpointStatus', required — AwsEgressPrivateLinkEndpointStatus kind.
- `vpc_endpoint_id` string, required — ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service.
- `vpc_endpoint_dns_name` string, required — DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service.
- object — Status of an AWS Ingress Private Link Endpoint.
- `kind` 'AwsIngressPrivateLinkEndpointStatus', required — AwsIngressPrivateLinkEndpointStatus kind.
- `vpc_endpoint_service_name` string, required — ID of the Confluent Cloud VPC Endpoint service used for PrivateLink.
- `vpc_endpoint_id` string, required — ID of the VPC Endpoint used for connecting to the VPC Endpoint service.
- `dns_domain` string — DNS domain name used to configure the Private Hosted Zone for the Access Point.
- object — Status of an Azure Private Endpoint.
- `kind` 'AzureEgressPrivateLinkEndpointStatus', required — AzureEgressPrivateLinkEndpointStatus kind.
- `private_endpoint_resource_id` string, required — Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
- `private_endpoint_domain` string — Domain of the Private Endpoint (if any) that is connected to the Private Link service.
- `private_endpoint_ip_address` string, required — IP address of the Private Endpoint (if any) that is connected to the Private Link service.
- `private_endpoint_custom_dns_config_domains` string[] — Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup.
- object — Status of an Azure Ingress Private Link Endpoint.
- `kind` 'AzureIngressPrivateLinkEndpointStatus', required — AzureIngressPrivateLinkEndpointStatus kind.
- `private_link_service_alias` string, required — Alias of the Confluent Cloud Private Link Service.
- `private_link_service_resource_id` string, required — Resource ID of the Confluent Cloud Private Link Service.
- `private_endpoint_resource_id` string, required — Resource ID of the Private Endpoint used for connecting to the Private Link Service.
- `dns_domain` string — DNS domain name used to configure the Private DNS Zone for the Access Point.
- object — Status of a GCP Private Service Connect Endpoint.
- `kind` 'GcpEgressPrivateServiceConnectEndpointStatus', required — GcpEgressPrivateServiceConnectEndpointStatus kind.
- `private_service_connect_endpoint_connection_id` string, required — Connection ID of the Private Service Connect Endpoint (if any) that is connected to the endpoint target.
- `private_service_connect_endpoint_name` string, required — Name of the Private Service Connect Endpoint (if any) that is connected to the endpoint target.
- `private_service_connect_endpoint_ip_address` string, required — IP address of the Private Service Connect Endpoint (if any) that is connected to the endpoint target.
- object — Status of a GCP Ingress Private Service Connect Endpoint.
- `kind` 'GcpIngressPrivateServiceConnectEndpointStatus', required — GcpIngressPrivateServiceConnectEndpointStatus kind.
- `private_service_connect_service_attachment` string, required — URI of the Private Service Connect Service Attachment in Confluent Cloud.
- `private_service_connect_connection_id` string, required — The ID of the Private Service Connect connection.
- `dns_domain` string — DNS domain name used to configure the DNS Zone for the Access Point.
## Other responses
- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `404` — Not Found
- `409` — The request is in conflict with the current server state
- `422` — Validation Failed
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!
---
[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)