Skip to main content
PATCH
/
projects
/
{slug}
Update Project Information
curl --request PATCH \
  --url https://relytone.data.cloud/api/v1/projects/{slug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "active",
  "region": "<string>",
  "cloudProvider": "aws",
  "pgVersion": 123,
  "bizId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "organizationId": "<string>",
  "organization": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "members": [
      {
        "id": "<string>",
        "userId": "<string>",
        "role": "owner",
        "user": {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "image": "<string>"
        }
      }
    ],
    "projects": [
      {}
    ],
    "_count": {
      "projects": 123,
      "members": 123
    }
  },
  "branches": [
    {
      "id": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "status": "creating",
      "isPrimary": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "projectId": "<string>",
      "computes": [
        {
          "id": "<string>",
          "slug": "<string>",
          "name": "<string>",
          "status": "READY",
          "cloudProvider": "aws",
          "instanceType": "<string>",
          "host": "<string>",
          "poolerHost": "<string>",
          "bizId": 123,
          "taskId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "branchId": "<string>",
          "createUser": {
            "id": "<string>",
            "name": "<string>",
            "email": "<string>"
          }
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

slug
string
required

Project identifier

Body

application/json
name
string

Project name

description
string

Project description

Response

Update successful

id
string

Project unique identifier

slug
string

Project identifier

name
string

Project name

description
string

Project description

status
enum<string>

Project status

Available options:
active,
inactive,
deleted
region
string

Project region

cloudProvider
enum<string>

Cloud service provider

Available options:
aws,
gcp,
azure,
aliyun
pgVersion
integer

PostgreSQL version

bizId
integer

Business ID

createdAt
string<date-time>

Creation time

updatedAt
string<date-time>

Update time

organizationId
string

Parent organization ID

organization
object
branches
object[]
I