Skip to main content
GET
/
organizations
/
{organization}
/
databases
/
{database_name}
/
cidrs
List IP restriction entries
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database_name}/cidrs \
  --header 'Authorization: <api-key>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "schema": "<string>",
      "role": "<string>",
      "cidrs": [
        "<string>"
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>",
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required

The name of the organization the database belongs to

database_name
string
required

The name of the database

Query Parameters

page
number
default:1

If provided, specifies the page offset of returned results

per_page
number
default:25

If provided, specifies the number of returned results

Response

Returns IP restriction entries for the database

current_page
number
required

The current page number

next_page
number
required

The next page number

next_page_url
string
required

The next page of results

prev_page
number
required

The previous page number

prev_page_url
string
required

The previous page of results

data
object[]
required