v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Branch

Reset role password

Resets the password for the specified Postgres role. Returns a new password and operations. The new password is ready to use when the last operation finishes. The old password remains valid until last operation finishes. Connections to the compute endpoint are dropped. If idle, the compute endpoint becomes active for a short period of time.

For related information, see Manage roles.

post/projects/{project_id}/branches/{branch_id}/roles/{role_name}/reset_password

Response

Reset the password for the specified role

Example response

{
  "role": {
    "branch_id": "br-wispy-meadow-118737",
    "name": "casey",
    "protected": false,
    "created_at": "2022-11-23T17:42:25Z",
    "updated_at": "2022-11-23T17:42:25Z"
  },
  "operations": [
    {
      "id": "d8ac46eb-a757-42b1-9907-f78322ee394e",
      "project_id": "spring-example-302709",
      "branch_id": "br-wispy-meadow-118737",
      "endpoint_id": "ep-silent-smoke-806639",
      "action": "start_compute",
      "status": "finished",
      "failures_count": 0,
      "created_at": "2022-11-15T20:02:00Z",
      "updated_at": "2022-11-15T20:02:02Z",
      "total_duration_ms": 200
    }
  ]
}