Update project

Update project properties such as name, icon, and commands.

PATCH /project/{projectID}

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

const client = createCognitioClient()
await client.project.update({
  ...
})

200

{
  "id": "<string>",
  "worktree": "<string>",
  "time": {
    "created": 123,
    "updated": 123,
    "initialized": 123
  },
  "sandboxes": [
    "<string>"
  ],
  "vcs": "git",
  "name": "<string>",
  "icon": {
    "url": "<string>",
    "override": "<string>",
    "color": "<string>"
  },
  "commands": {
    "start": "<string>"
  }
}

Path Parameters

projectID · string · required

Query Parameters

directory · string

workspace · string

Body

application/json

name · string

icon · object

Show child attributes

commands · object

Show child attributes

Response

200

application/json

Updated project information

id · string · required

worktree · string · required

time · object · required

Show child attributes

sandboxes · string[] · required

vcs · string

Allowed value: "git"

name · string

icon · object

Show child attributes

commands · object

Show child attributes