Update Project

Update an existing project configuration

PUT /api/trpc/projects.update

Update Project

cURL

curl --request PUT \
  --url https://api.example.com/api/trpc/projects.update \
  --header 'Content-Type: application/json' \
  --data '
{
  "0.json.data": {
    "project_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "settings": {
      "base_url": "<string>",
      "default_timeout": 123,
      "environment": "<string>",
      "viewport": {
        "width": 123,
        "height": 123
      }
    },
    "tags": [
      {}
    ]
  }
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "updated_at": "<string>",
  "settings": {},
  "tags": [
    {}
  ],
  "400 Bad Request": {},
  "404 Not Found": {},
  "401 Unauthorized": {},
  "409 Conflict": {}
}

Path Parameters

project_id · string · required

The unique identifier of the project to update

Request Body

0.json.data · object

Show properties

project_id · string · required

The unique identifier of the project to update

name · string

The new name for the project

description · string

Updated project description

settings · object

Show properties

base_url · string

The base URL of the application to be tested

default_timeout · integer

Default timeout in seconds for test executions

environment · string

Target environment (e.g., ‘development’, ‘staging’, ‘production’)

viewport · object

Browser viewport settings

Show properties

width · integer

Viewport width in pixels

height · integer

Viewport height in pixels

tags · array

Updated list of project tags

Response

id · string

The unique identifier of the project

name · string

The updated name of the project

description · string

The updated project description

updated_at · string

ISO 8601 timestamp of when the project was last updated

settings · object

Updated project configuration settings

tags · array

Updated list of project tags

Example Request

curl -X PUT https://api.tryiris.dev/api/trpc/projects.update \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "0": {
      "json": {
        "data": {
          "project_id": "prj_9a8b7c6d5e",
          "name": "e-commerce-testing-v2",
          "description": "Updated end-to-end testing suite for our e-commerce platform",
          "settings": {
            "base_url": "https://shop.example.com",
            "default_timeout": 60,
            "environment": "production",
            "viewport": {
              "width": 1440,
              "height": 900
            }
          },
          "tags": ["e-commerce", "web", "production"]
        }
      }
    }
  }'

Example Response

{
  "id": "prj_9a8b7c6d5e",
  "name": "e-commerce-testing-v2",
  "description": "Updated end-to-end testing suite for our e-commerce platform",
  "created_at": "2024-01-20T11:00:00Z",
  "updated_at": "2024-01-20T12:00:00Z",
  "settings": {
    "base_url": "https://shop.example.com",
    "default_timeout": 60,
    "environment": "production",
    "viewport": {
      "width": 1440,
      "height": 900
    }
  },
  "tags": ["e-commerce", "web", "production"]
}

Error Responses

400 Bad Request · object

Invalid request body or parameters

{
  "error": "invalid_request",
  "message": "Invalid viewport dimensions"
}

404 Not Found · object

Project not found

{
  "error": "not_found",
  "message": "Project not found"
}

401 Unauthorized · object

Missing or invalid API key

{
  "error": "unauthorized",
  "message": "Invalid API key provided"
}

409 Conflict · object

Project name already exists

{
  "error": "conflict",
  "message": "Project name already exists"
}