Add One Interface Endpoint to a Private Endpoint Connection¶
This endpoint is deprecated. Please use /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint instead.
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
.
Add one interface endpoint to a private endpoint connection in an Atlas project.
You must first create the endpoint in AWS with the following information:
The endpoint service Atlas creates with /groups/{GROUP-ID}/privateEndpoint.
Retrieve the endpoint service name with /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}.
- Unique identifier of the peer AWS VPC .
- Unique identifiers of the subnets your AWS VPC uses.
If the attempt to add an interface endpoint fails, delete it, then try to add a new one.
The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
To learn how to configure API access for an Atlas project, see Configure Atlas API Access.
Required Roles¶
You must have one of the following roles to successfully call this resource:
Request¶
https://cloud.mongodb.com/api/atlas/v1.0
POST /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints
Request Path Parameters¶
Path Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID | Required | Unique identifier for the project. |
privateLinkId | Required | Unique identifier of the AWS PrivateLink connection. |
Request Query Parameters¶
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the total number of objects. | 1 |
itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum of 500. | 100 |
includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount parameter in the response body. | true |
pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON response in the prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
Body Parameter | Type | Necessity | Description |
---|---|---|---|
interfaceEndpointId | string | Required | Unique identifier of the interface endpoint you created in your VPC. |
Response Elements¶
Response Parameter | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
connectionStatus | string | Status of the interface endpoint. Returns one of the following values:
| ||||||||||||||
deleteRequested | boolean | Flag that indicates whether Atlas received a request to remove the interface endpoint from the private endpoint connection. | ||||||||||||||
errorMessage | string | Error message pertaining to the interface endpoint. Atlas returns null if there are no errors. | ||||||||||||||
interfaceEndpointId | string | Unique identifier of the interface endpoint. |
Example Request¶
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints?pretty=true" \ 5 --data ' 6 { 7 "interfaceEndpointId":"vpce-0b9c5701325cb15dd" 8 }'
Example Response¶
1 { 2 "connectionStatus": "PENDING", 3 "deleteRequested": false, 4 "errorMessage": null, 5 "interfaceEndpointId": "vpce-08fb7e9319909ec7b" 6 }