Instance Endpoints

Instance endpoints enable connection to your instance.

Create a new Instance endpoint

POST

https://api.scaleway.com

/mongodb/v1/regions/{region}/endpoints

Create a new endpoint for a MongoDB® Database Instance. You can add public_network or private_network specifications to the body of the request.

Create a new Instance endpoint › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a new Instance endpoint › Request Body

instance_id

string · required

UUID of the Database Instance.

scaleway.mongodb.v1.EndpointSpec · required

EndpointSpec used to expose your Database Instance.

Create a new Instance endpoint › Responses

200

scaleway.mongodb.v1.Endpoint

id

string

UUID of the endpoint. (UUID format)

dns_record

string

List of DNS records of the endpoint.

port

integer · uint32

TCP port of the endpoint.

Private Network endpoint details.

Public Network endpoint details.

Delete a Database Instance endpoint

DELETE

https://api.scaleway.com

/mongodb/v1/regions/{region}/endpoints/{endpoint_id}

Delete the endpoint of a Database Instance. You must specify the endpoint_id parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.

Delete a Database Instance endpoint › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

endpoint_id

string · required

UUID of the Endpoint to delete.

Delete a Database Instance endpoint › Responses

No data returned

Users Databases