Skip to content
Management API Reference

Create a login role for CLI with temporary password

post/v1/projects/{ref}/cli/login-role

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

  • database:write

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

  • database_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • read_only
    Required
    boolean

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Response (201)

{
  "role": "lorem",
  "password": "lorem",
  "ttl_seconds": 1
}