XAxataio
Branches

Update branch details

Changed on

Updates the configuration of a specific branch by its ID, such as changing its name, description, or resource allocation.

patch/organizations/{organizationID}/projects/{projectID}/branches/{branchID}

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: branch:write

Path parameters

organizationIDstring required

Unique identifier of the organization containing the project

projectIDstring required

Unique identifier of the project containing the branch

branchIDstring required

Unique identifier of the branch to update

Request body

namestring

New name for the branch

descriptionstring

New description for the branch. Send an empty string to clear it.

replicasinteger

Number of database replicas to scale to

storageinteger

Branch storage in GiB (gigabytes). The maximum allowed value depends on the organization's storage limit.

instanceTypestring

New instance type for the branch

hibernateboolean

Enabled when the branch should be hibernated, disabled if it needs to be reactivated.

postgresConfigurationParametersobject

Arbitrary PostgreSQL configuration parameters for the cluster

preloadLibrariesstring[]

List of PostgreSQL extensions and libraries to preload

imagestring

PostgreSQL image to use for the database instances

Response

Branch successfully updated

idstring required

Unique identifier for the branch

namestring required

Human-readable name of the branch

descriptionstring

Optional description of the branch purpose or contents

createdAtstring date-time required

Timestamp when the branch was created

updatedAtstring date-time required

Timestamp when the branch was last updated

parentIDstring nullable

Identifier of the parent branch if this is a derived branch, null otherwise

connectionStringstring nullable

Deprecated: retrieve the connection string from the branch credentials endpoint (GET .../branches/{branchID}/credentials) instead. The hostname in this connection string carries a -deprecated marker in its first DNS label.

regionstring required

Geographic region where the branch is deployed

publicAccessboolean required

Whether the branch allows public access without authentication

Changes

  • e6493d6906d1Revision changes
    • warning

      the request property's maxLength was set to 255

    • warning

      changed the pattern of the request property from ^[a-zA-Z0-9]+[a-zA-Z0-9- ]*$ to ^([a-zA-Z0-9][a-zA-Z0-9\-_./: ]*)?$

  • 16f6200eae92Revision changes
    • info

      response property connectionString deprecated