Skip to content
Management API Reference

Updates project's network restrictions by adding or removing CIDRs

patch/v1/projects/{ref}/network-restrictions

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 Alpha 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

  • add
    Optional
    object
  • remove
    Optional
    object

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "entitlement": "disallowed",
  "config": {
    "dbAllowedCidrs": [
      {
        "address": "lorem",
        "type": "v4"
      }
    ]
  },
  "old_config": {
    "dbAllowedCidrs": [
      {
        "address": "lorem",
        "type": "v4"
      }
    ]
  },
  "updated_at": "4404-02-29T04:24Z",
  "applied_at": "4404-02-29T04:24Z",
  "status": "stored"
}