Skip to main content
PATCH
/
projects
/
{id}
Update Project Information
curl --request PATCH \
  --url https://relytone.data.cloud/api/v1/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "active",
  "region": "<string>",
  "pgVersion": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "organization": {
    "id": "<string>",
    "name": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Project identifier

Body

application/json
name
string

Project name

description
string

Project description

Response

Update successful

id
string

Project identifier

name
string

Project name

status
enum<string>

Project status

Available options:
active,
inactive,
deleted
region
string

Project region

pgVersion
integer

PostgreSQL version

createdAt
string<date-time>

Creation time

updatedAt
string<date-time>

Update time

organization
object