Skip to content
Management API Reference

Updates project's network restrictions

post/v1/projects/{ref}/network-restrictions/apply

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

This endpoint is currently in its Beta stage.

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_network_restrictions_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • dbAllowedCidrs
    Optional
    Array<string>
  • dbAllowedCidrsV6
    Optional
    Array<string>

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Response (201)

{
  "entitlement": "disallowed",
  "config": {
    "dbAllowedCidrs": [
      "203.0.113.0/24"
    ],
    "dbAllowedCidrsV6": [
      "2001:db8::/32"
    ]
  },
  "old_config": {
    "dbAllowedCidrs": [
      "203.0.113.0/24"
    ],
    "dbAllowedCidrsV6": [
      "2001:db8::/32"
    ]
  },
  "status": "stored",
  "updated_at": "4404-02-29T04:24Z",
  "applied_at": "4404-02-29T04:24Z"
}