Create One Private Endpoint Service for One Provider

POST /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService

Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role.

Private Endpoint Concepts

Path parameters

groupId string Required

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.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

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.

Default value is false.
pretty boolean

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

Default value is false.

application/vnd.atlas.2023-01-01+json

Body Required

Creates one private endpoint for the specified cloud service provider.

providerName string Required

Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.

Values are AWS, AZURE, or GCP.
region string Required

Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for Amazon Web Services, Google Cloud Platform, and Microsoft Azure.

Responses

200 application/vnd.atlas.2023-01-01+json

OK
One of:
AWS object AZURE object GCP object
Group of Private Endpoint Service settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint service.

Value is AWS.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

id string

Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

regionName string

Cloud provider region that manages this Private Endpoint Service.

status string

State of the Private Endpoint Service connection when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED, or DELETING.

endpointServiceName string

Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.

Format should match the following pattern: ^com\.amazonaws\.vpce\.[a-z-0-9]+\.vpce-svc-[0-9a-f]{17}.

interfaceEndpoints array[string]

List of strings that identify private endpoint interfaces applied to the specified project.

Minimum length of each is 24, maximum length of each is 24. Format of each should match the following pattern: ^([a-f0-9]{24})$.
Group of Private Endpoint Service settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint service.

Value is AZURE.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

id string

Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

regionName string

Cloud provider region that manages this Private Endpoint Service.

status string

State of the Private Endpoint Service connection when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED, or DELETING.

privateEndpoints array[string]

List of private endpoints assigned to this Azure Private Link Service.

Format of each should match the following pattern: ^\/subscriptions\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/resource[gG]roups\/([-\w._()]+)\/providers\/Microsoft\.Network\/privateEndpoints\/([-\w._()]+).

privateLinkServiceName string

Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^pls_[0-9a-f]{24}$.

privateLinkServiceResourceId string

Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.
Group of Private Endpoint Service settings.

Hide attributes Show attributes

cloudProvider string Required Discriminator

Cloud service provider that serves the requested endpoint service.

Value is GCP.

errorMessage string

Error message returned when requesting private connection resource. The resource returns null if the request succeeded.

id string

Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

regionName string

Cloud provider region that manages this Private Endpoint Service.

status string

State of the Private Endpoint Service connection when MongoDB Cloud received this request.

Values are INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED, or DELETING.

endpointGroupNames array[string]

List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.

serviceAttachmentNames array[string]

List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.

Format of each should match the following pattern: https:\/\/([a-z0-9\.]+)+\.[a-z]{2,}(\/[a-z0-9\-]+)+\/projects\/p-[a-z0-9]+\/regions\/[a-z\-0-9]+\/serviceAttachments\/[a-z0-9\-]+.
400 application/json

Bad Request.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- 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 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- 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.

POST /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService

atlas api privateEndpointServices createPrivateEndpointService --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreatePrivateEndpointServiceApiParams{}
	sdkResp, httpResp, err := client.PrivateEndpointServicesApi.
		CreatePrivateEndpointServiceWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \
  -d '{ <Payload> }'

Request examples

{
  "providerName": "AWS",
  "region": "string"
}

Response examples (200)

{
  "cloudProvider": "AWS",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointServiceName": "string",
  "interfaceEndpoints": [
    "32b6e34b3d91647abb20e7b8"
  ]
}

{
  "cloudProvider": "AZURE",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "privateEndpoints": [
    "string"
  ],
  "privateLinkServiceName": "string",
  "privateLinkServiceResourceId": "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de"
}

{
  "cloudProvider": "GCP",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointGroupNames": [
    "string"
  ],
  "serviceAttachmentNames": [
    "string"
  ]
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}