# Return One Private Link Connection

**GET /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}**

Returns the details of one Private Link connection within the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.


## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
- **connectionId** (string)
  Unique ID that identifies the Private Link connection.

### Query parameters
- **envelope** (boolean)
  Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.


## Responses
### 200
OK

#### Body: application/vnd.atlas.2023-02-01+json (object)
- **_id** (string)
  The ID of the Private Link connection.
- **arn** (string)
  Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
- **azureResourceIds** (array[string])
  Azure Resource IDs of each availability zone for the Azure Confluent cluster.
- **dnsDomain** (string)
  The domain hostname. Required for the following provider and vendor combinations:
  - AWS provider with CONFLUENT vendor.
  - AZURE provider with EVENTHUB or CONFLUENT vendor.
- **dnsSubDomain** (array[string])
  Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor, if your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array [].
- **errorMessage** (string)
  Error message if the state is FAILED.
- **gcpConnectionIds** (array[string])
  List of GCP Private Service Connect connection IDs.
- **gcpServiceAttachmentUris** (array[string])
  Service Attachment URIs of each availability zone for the GCP Confluent cluster.
- **interfaceEndpointId** (string)
  Interface endpoint ID that is created from the service endpoint ID provided.
- **interfaceEndpointName** (string)
  Interface endpoint name that is created from the service endpoint ID provided.
- **links** (array[object])
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
- **provider** (string)
  Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
- **providerAccountId** (string)
  Account ID from the cloud provider.
- **region** (string)
  The region of the Provider’s cluster. See [AZURE](https://www.mongodb.com/zh-cn/docs/atlas/reference/microsoft-azure/#stream-processing-instances) and [AWS](https://www.mongodb.com/zh-cn/docs/atlas/reference/amazon-aws/#stream-processing-instances) supported regions.
- **serviceEndpointId** (string)
  For AZURE EVENTHUB, this is the [namespace endpoint ID](https://learn.microsoft.com/en-us/rest/api/eventhub/namespaces/get). For AWS CONFLUENT cluster, this is the [VPC Endpoint service name](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).
- **state** (string)
  State the connection is in.
- **vendor** (string)
  Vendor that manages the cloud service. The following are the vendor values per provider:
  - AWS
  -- MSK for AWS MSK Kafka clusters
  -- CONFLUENT for Confluent Kafka clusters on AWS
  -- KINESIS for AWS Kinesis Data Streams (coming soon).

  - Azure
  -- EVENTHUB for Azure EventHub.
  -- CONFLUENT for the Confluent Kafka clusters on Azure

  **NOTE** Omitting the vendor field will default to using the GENERIC vendor.

### 401
Unauthorized.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403
Forbidden.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404
Not Found.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500
Internal Server Error.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)