Update a project with the Chainstack Platform API v2

Update the name or description of a project using the Chainstack Platform API v2. Send a PATCH request to /v2/projects// with the updated values.

PATCH /v2/projects/{id}

Update project

cURL

curl --request PATCH \
  --url https://api.chainstack.com/v2/projects/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My updated project",
  "description": "Updated description"
}
'

200

{
  "id": "PR-123-456-789",
  "name": "My updated project",
  "description": "Updated description",
  "type": "public",
  "members": 0,
  "networks": 1,
  "creator": {
    "id": "UR-111-111-111",
    "email": "[e-mail]",
    "first_name": "John",
    "last_name": "Smith",
    "organization": {
      "id": "RG-123-456",
      "name": "My organization"
    }
  },
  "created_at": "2023-01-01T00:00:00.000000Z"
}

Authorizations

Authorization · string · header · required

Chainstack API uses API keys to authenticate requests. You can view and manage your API keys in the platform UI. Your API keys carry many privileges, so be sure to keep them secure! Provide your API key as the Authorization header. The value of the header consists of Bearer prefix and secret key generated through the platform UI.

curl -X GET 'https://api.chainstack.com/v1/organization/' \
--header 'Authorization: Bearer FX7CWlLg.FMpAO8cgCX2N7s41EncRru2nb5CmTZUt'

All API requests must be made over HTTPS.

Path Parameters

id · string · required

A unique value identifying the Object.

Body

application/json

name · string

Name of the project.

description · string

Description of the project.

type · enum<string> · default: public

Type of the project.

• public for public chain project

Available options: public

created_at · string<date-time>

When the project was created.

Response

200

application/json

id · string · read-only

name · string

Name of the project.

description · string

Description of the project.

type · enum<string> · default: public

Type of the project.

• public for public chain project

Available options: public

members · integer · read-only

Number of members invited to the consortium project.
Only for the consortium project.

networks · integer · read-only

Number of networks created in the project.

creator · object · read-only

Creator of the project.

Show child attributes

created_at · string<date-time>

When the project was created.