Get Database IP Allowlist

GET

/dbaas/{managed_db_id}/allowlist/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/dbaas/{managed_db_id}/allowlist/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    "https://api.e2enetworks.com/myaccount/api/v1/gpu/dbaas/{managed_db_id}/allowlist/",
    params={"project_id": "<PROJECT_ID>", "location": "<LOCATION>", "apikey": "<API_KEY>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/gpu/dbaas/{managed_db_id}/allowlist/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", location: "<LOCATION>", apikey: "<API_KEY>" });

const response = await fetch(url, {
  method: "GET",
  headers: { "Authorization": "Bearer <API_TOKEN>" },
});
console.log(await response.json());

Returns the IP allowlist and the public IPv4 address the call came from, for adding your own address. Needs the Read permission on DBaaS.

Parameters

Path Parameters

managed_db_id

required

integer

Database ID

Query Parameters

project_id

required

integer

Project ID

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Responses

200

The allowlist

application/json

object

code

integer

message

string

data

object

ip_allowlist

Array<object>

object

cidr

string

label

Description of the range; empty when none was given.

string

your_ip

null when no IPv4 address was found.

string

nullable

your_ip_cidr

string

nullable

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "ip_allowlist": [
      {
        "cidr": "203.0.113.0/24",
        "label": "office VPN"
      }
    ],
    "your_ip": "198.51.100.7",
    "your_ip_cidr": "198.51.100.7/32"
  },
  "errors": {}
}

400

The project ID is missing or is not a number.

application/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {},
  "errors": "Project ID is missing or invalid"
}

403

The caller lacks the permission the call needs on the project, or the region is not allowed.

application/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 403,
  "message": "Forbidden",
  "data": {},
  "errors": "You don't have permission to access this service. Please verify your policy or project."
}

404

No database with that ID in the project and region.

application/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Invalid request! Database Not Found"
}