---
title: "Update a Private Link Attachment Connection"
method: PATCH
path: "/networking/v1/private-link-attachment-connections/{id}"
tags: ["Private Link Attachment Connections (networking/v1)"]
---
# Update a Private Link Attachment Connection
`PATCH /networking/v1/private-link-attachment-connections/{id}`
[](#section/Versioning/API-Lifecycle-Policy)
Make a request to update a private link attachment connection.
## Path parameters
- `id` string, required
## Request body
- object — PrivateLink attachment connection objects represent connections established to a cloud region in order to access resources that belong to a Confluent Cloud Environment. The API allows you to list, create, read update and delete your PrivateLink attachment connections. ## The Private Link Attachment Connections Model
- `api_version` 'networking/v1' — APIVersion defines the schema version of this representation of a resource.
- `kind` 'PrivateLinkAttachmentConnection' — 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 Private Link Attachment Connection
- `display_name` string — The name of the PrivateLink attachment connection.
- `cloud` union — The cloud-specific PrivateLink attachment connection details.
- object — Represents a connection between an AWS VPC Endpoint and an Endpoint service.
- `kind` 'AwsPrivateLinkAttachmentConnection', required — PrivateLinkAttachmentConnection kind.
- `vpc_endpoint_id` string, required — Id of a VPC Endpoint that is connected to the VPC Endpoint service.
- object — Represents a connection between an Azure PrivateLink service and a PrivateEndpoint.
- `kind` 'AzurePrivateLinkAttachmentConnection', required — PrivateLinkAttachmentConnection kind.
- `private_endpoint_resource_id` string, required — Resource Id of the PrivateEndpoint that is connected to the PrivateLink service.
- object — Represents a connection between a GCP PSC Service Attachment and a PSC Endpoint.
- `kind` 'GcpPrivateLinkAttachmentConnection', required — PrivateLinkAttachmentConnection kind.
- `private_service_connect_connection_id` string, required — Id of the Private Service 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
- `private_link_attachment` 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` NetworkingV1PrivateLinkAttachmentConnectionStatus — The status of the Private Link Attachment Connection
- `phase` string, required — The lifecycle phase of the PrivateLink attachment: PROVISIONING: PrivateLink attachment connection provisioning is in progress; READY: PrivateLink attachment connection is ready; FAILED: PrivateLink attachment connection is in a failed state; DEPROVISIONING: PrivateLink attachment connection deprovisioning is in progress; DISCONNECTED:| PrivateLink attachment connection is in a disconnected state. This means the private endpoint associated with this PrivateLink attachment connection has been deleted;
- `error_code` string — Error code if PrivateLink attachment connection is in a failed state. May be used for programmatic error checking.
- `error_message` string — Displayable error message if PrivateLink attachment connection is in a failed state.
- `cloud` union — The cloud specific status of the PrivateLink attachment connection.
- object — Status of a connection to an AWS PrivateLink attachment.
- `kind` 'AwsPrivateLinkAttachmentConnectionStatus', required — PrivateLinkAttachmentConnectionStatus kind.
- `vpc_endpoint_service_name` string, required — Id of the VPC Endpoint service used for PrivateLink.
- `vpc_endpoint_id` string, required — Id of the VPC Endpoint (if any) that is connected to the VPC Endpoint service.
- object — Status of a Azure PrivateLink attachment connection.
- `kind` 'AzurePrivateLinkAttachmentConnectionStatus', required — PrivateLinkAttachmentConnectionStatus kind.
- `private_link_service_alias` string, required — Azure PrivateLink service alias.
- `private_link_service_resource_id` string, required — Azure PrivateLink service resource id.
- `private_endpoint_resource_id` string, required — Resource Id of the PrivateEndpoint (if any) that is connected to the PrivateLink service.
- object — Status of GCP PrivateLink attachment connection.
- `kind` 'GcpPrivateLinkAttachmentConnectionStatus', required — PrivateLinkAttachmentConnectionStatus kind.
- `private_service_connect_service_attachment` string, required — GCP Private Service Connect ServiceAttachment.
- `private_service_connect_connection_id` string, required — Id of the Private Service connection.
## Response `200`
Private Link Attachment Connection.
- object — PrivateLink attachment connection objects represent connections established to a cloud region in order to access resources that belong to a Confluent Cloud Environment. The API allows you to list, create, read update and delete your PrivateLink attachment connections. ## The Private Link Attachment Connections Model
- `api_version` 'networking/v1', required — APIVersion defines the schema version of this representation of a resource.
- `kind` 'PrivateLinkAttachmentConnection', 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 Private Link Attachment Connection
- `display_name` string — The name of the PrivateLink attachment connection.
- `cloud` union, required — The cloud-specific PrivateLink attachment connection details.
- object — Represents a connection between an AWS VPC Endpoint and an Endpoint service.
- `kind` 'AwsPrivateLinkAttachmentConnection', required — PrivateLinkAttachmentConnection kind.
- `vpc_endpoint_id` string, required — Id of a VPC Endpoint that is connected to the VPC Endpoint service.
- object — Represents a connection between an Azure PrivateLink service and a PrivateEndpoint.
- `kind` 'AzurePrivateLinkAttachmentConnection', required — PrivateLinkAttachmentConnection kind.
- `private_endpoint_resource_id` string, required — Resource Id of the PrivateEndpoint that is connected to the PrivateLink service.
- object — Represents a connection between a GCP PSC Service Attachment and a PSC Endpoint.
- `kind` 'GcpPrivateLinkAttachmentConnection', required — PrivateLinkAttachmentConnection kind.
- `private_service_connect_connection_id` string, required — Id of the Private Service 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
- `private_link_attachment` object, required — The private_link_attachment 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` NetworkingV1PrivateLinkAttachmentConnectionStatus, required — The status of the Private Link Attachment Connection
- `phase` string, required — The lifecycle phase of the PrivateLink attachment: PROVISIONING: PrivateLink attachment connection provisioning is in progress; READY: PrivateLink attachment connection is ready; FAILED: PrivateLink attachment connection is in a failed state; DEPROVISIONING: PrivateLink attachment connection deprovisioning is in progress; DISCONNECTED:| PrivateLink attachment connection is in a disconnected state. This means the private endpoint associated with this PrivateLink attachment connection has been deleted;
- `error_code` string — Error code if PrivateLink attachment connection is in a failed state. May be used for programmatic error checking.
- `error_message` string — Displayable error message if PrivateLink attachment connection is in a failed state.
- `cloud` union — The cloud specific status of the PrivateLink attachment connection.
- object — Status of a connection to an AWS PrivateLink attachment.
- `kind` 'AwsPrivateLinkAttachmentConnectionStatus', required — PrivateLinkAttachmentConnectionStatus kind.
- `vpc_endpoint_service_name` string, required — Id of the VPC Endpoint service used for PrivateLink.
- `vpc_endpoint_id` string, required — Id of the VPC Endpoint (if any) that is connected to the VPC Endpoint service.
- object — Status of a Azure PrivateLink attachment connection.
- `kind` 'AzurePrivateLinkAttachmentConnectionStatus', required — PrivateLinkAttachmentConnectionStatus kind.
- `private_link_service_alias` string, required — Azure PrivateLink service alias.
- `private_link_service_resource_id` string, required — Azure PrivateLink service resource id.
- `private_endpoint_resource_id` string, required — Resource Id of the PrivateEndpoint (if any) that is connected to the PrivateLink service.
- object — Status of GCP PrivateLink attachment connection.
- `kind` 'GcpPrivateLinkAttachmentConnectionStatus', required — PrivateLinkAttachmentConnectionStatus kind.
- `private_service_connect_service_attachment` string, required — GCP Private Service Connect ServiceAttachment.
- `private_service_connect_connection_id` string, required — Id of the Private Service connection.
## 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)