Skip to main content
PATCH
/
organizations
/
{organizationID}
/
projects
/
{projectID}
Update project details
curl --request PATCH \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "configuration": {
    "scaleToZero": {
      "baseBranches": {
        "enabled": true,
        "inactivityPeriodMinutes": 123
      },
      "childBranches": {
        "enabled": true,
        "inactivityPeriodMinutes": 123
      }
    }
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "configuration": {
    "scaleToZero": {
      "baseBranches": {
        "enabled": true,
        "inactivityPeriodMinutes": 123
      },
      "childBranches": {
        "enabled": true,
        "inactivityPeriodMinutes": 123
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organizationID
string
required

Unique identifier of the organization containing the project

​
projectID
string
required

Unique identifier of the project to update

Body

application/json
​
name
string

New name for the project

​
configuration
object

Configuration details for a project, including its scale to zero settings

Response

Project successfully updated

Details of a project including its ID, name, and creation/update timestamps

​
id
string
required

Unique identifier for the project

​
name
string
required

Human-readable name of the project

​
createdAt
string<date-time>
required

Timestamp when the project was created

​
updatedAt
string<date-time>
required

Timestamp when the project was last updated

​
configuration
object
required

Configuration details for a project, including its scale to zero settings