Skip to main content
POST
Update a project

Authorizations

X-Access-Key
string
header
required

An API key is a token that a client provides when making API calls. Send it as the X-Access-Key request header on any endpoint:

Learn how to generate API access tokens at Tenderly Docs.

Path Parameters

accountSlug
string
required

Account slug of the user

projectSlug
string
required

Project slug of the account

Body

application/json

Project changes

Partial update. Only the fields present in the request are applied; at least one must be present.

name
string

New project name, 1 to 100 characters. The slug stays unchanged.

Required string length: 1 - 100
Example:

"Mainnet Monitoring v2"

options
options · object

Replaces the project options object.

restricted
boolean

Organization projects only. true restricts the project to its explicit members; false opens it to every organization member. Restricting without members keeps every current organization member as a project member, so visibility does not change. Restricting together with members sets the member list to exactly the organization owner plus the given members (an empty list means the owner only).

Example:

true

members
string<uuid>[]

Organization projects only. Replaces the full member list with these principal IDs of accepted organization members. The organization owner is always kept. Cannot be combined with restricted: false.

Example:

Response

A successful response.

project
Project · object

A Tenderly project.