Databases

Update database

Updates the database with the given ID. logicalId cannot be combined with branchId or branchGitName in one request; move the database first, then set its logicalId.

patch/v1/databases/{databaseId}

Request

  • Base URL: https://api.prisma.io
  • URL: https://api.prisma.io/v1/databases/{databaseId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.prisma.io/authorize, token URL https://auth.prisma.io/token, scopes: workspace:admin, offline_access)
    • HTTP bearer

Path parameters

databaseIdstring required

Request body

namestring

New display name for the database

branchIdstring nullable

ID of the Branch to move the database to. Every database belongs to a Branch, so null (detach) is rejected.

branchGitNamestring nullable

Git name of the Branch to move the database to; the Branch is created when it does not exist. Mutually exclusive with branchId. Every database belongs to a Branch, so null (detach) is rejected.

logicalIdstring nullable

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource. Send null to clear the logical id.

Response

Updated the database.

Changes

No recorded changes to this operation across all 1 revision of this API.