MOmongodb
Streams

Create One Private Link Connection

Creates one Private Link in the specified project.

post/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.

Query parameters

envelopeboolean

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.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

_idstring

The ID of the Private Link connection.

arnstring

Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.

azureResourceIdsstring[]

Azure Resource IDs of each availability zone for the Azure Confluent cluster.

dnsDomainstring

The domain hostname. Required for the following provider and vendor combinations:

  • AWS provider with CONFLUENT vendor.
  • AZURE provider with EVENTHUB or CONFLUENT vendor.
dnsSubDomainstring[]

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 [].

errorMessagestring

Error message if the state is FAILED.

gcpConnectionIdsstring[]

List of GCP Private Service Connect connection IDs.

gcpServiceAttachmentUrisstring[]

Service Attachment URIs of each availability zone for the GCP Confluent cluster.

interfaceEndpointIdstring

Interface endpoint ID that is created from the service endpoint ID provided.

interfaceEndpointNamestring

Interface endpoint name that is created from the service endpoint ID provided.

providerstring required

Cloud provider where the private endpoint's target resource is deployed. Valid values are AWS, AZURE, and GCP.

providerAccountIdstring

Account ID from the cloud provider.

regionstring

The region of the Provider’s cluster. See AWS, AZURE, and GCP supported regions.

serviceEndpointIdstring

For AZURE EVENTHUB, this is the namespace endpoint ID. For AWS CONFLUENT cluster, this is the VPC Endpoint service name.

statestring

State the connection is in.

vendorstring

Vendor that manages the cloud service. The list of supported vendor values is:

  • AWS -- MSK for AWS MSK Kafka clusters -- CONFLUENT for Confluent Kafka clusters on AWS -- KINESIS for AWS Kinesis Data Streams

  • Azure -- EVENTHUB for Azure EventHub. -- CONFLUENT for Confluent Kafka clusters on Azure -- AZURE_BLOB_STORAGE for Azure Blob Storage

  • GCP -- CONFLUENT for Confluent Kafka clusters on GCP -- PUBSUB for Google Cloud Pub/Sub

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

Example request

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}

Response

OK

Changes

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