Skip to content
Management API Reference

Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.

put/v1/projects/{ref}/pgsodium

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

  • secrets:write

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

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • root_key
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "root_key": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
}