Skip to main content
PUT
/
v1
/
projects
/
{project_id}
Update Project
curl --request PUT \
  --url https://api.example.com/v1/projects/{project_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>' \
  --data '
{
  "name": "<string>",
  "configuration": {
    "retention": {
      "files": "<string>",
      "result_artifacts": "<string>"
    }
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "configuration": {
    "retention": {
      "files": "<string>",
      "result_artifacts": "<string>"
    }
  },
  "archived_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication

​
x-selected-account-id
string
header
required

Selected Account ID

Path Parameters

​
project_id
string
required

Body

application/json

Model for updating an existing project.

​
name
string | null

Project readable name

Required string length: 1 - 255
​
configuration
ProjectConfiguration · object

Project configuration

​
status
enum<string> | null

Project status

Available options:
active,
archived

Response

Successful Response

Project response model.

​
id
string
required

ID of the entity

​
name
string
required

Project readable name

​
status
enum<string>
required

Project status

Available options:
active,
archived
​
created_at
string<date-time>
required

Datetime when the project was created

​
configuration
ProjectConfiguration · object

Project configuration

​
archived_at
string<date-time> | null

Datetime when the project was archived