Skip to main content
PATCH
/
projects
/
{project_reference}
Update Project
curl --request PATCH \
  --url https://api.veryfront.com/projects/{project_reference} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Project Name",
  "description": "Updated description"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "slug": "my-project",
  "name": "My Project",
  "description": "A sample project description",
  "is_claimed": true,
  "features": [
    "<string>"
  ],
  "environments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "protected": true,
      "domains": [
        "<string>"
      ],
      "environment_variables": [
        "<unknown>"
      ],
      "active_release_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "server_hostname": "<string>"
    }
  ],
  "releases": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "export_status": "<string>",
      "build_status": "<string>",
      "deploy_status": "<string>"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "published_at": "<string>",
  "prompt_count": 123,
  "config": {},
  "provider": "<string>",
  "layout": "<string>",
  "users": [
    {
      "id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "role": "<string>",
      "avatar_src": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

project_reference
string
required

Project identifier: UUID, slug, or domain name

Example:

"my-project"

Body

application/json
slug
string
Minimum string length: 1
name
string
Minimum string length: 1
description
string
config

Response

Project updated successfully

id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

slug
string
required
Example:

"my-project"

name
string
required
Example:

"My Project"

description
string
Example:

"A sample project description"

is_claimed
boolean
features
string[]
environments
object[]
releases
object[]
created_at
string
Example:

"2024-01-15T10:30:00Z"

updated_at
string
Example:

"2024-01-15T10:30:00Z"

published_at
string
prompt_count
number
config
object
provider
string | null
layout
string | null
users
object[]