Chainstack API (v1)

Download OpenAPI specification:Download

A set of API endpoints to operate and manage the platform resources.
See also a quick API tutorial.

Authentication

API Key Authentication

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.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Organization

Get Organizaton name and ID

Get the name and ID of your organizaton.

Authorizations:

Responses

Response Schema: application/json
id
string
name
string

Name of the organization.

Response samples

Content type
application/json
{
  • "id": "RG-123-456",
  • "name": "My organization"
}

Update Organizaton name

Change the name of your organizaton.

Authorizations:
Request Body schema: application/json
name
string

Name of the organization.

Responses

Response Schema: application/json
id
string
name
string

Name of the organization.

Request samples

Content type
application/json
{
  • "name": "My organization"
}

Response samples

Content type
application/json
{
  • "id": "RG-123-456",
  • "name": "My organization"
}

Project

List all Projects

List all projects your organization is part of.

Authorizations:
query Parameters
order_by
string
Enum: "name" "created_at"

Which field to use when ordering the results.
Use the - prefix to perform descending ordering (-name).

page
integer

A page number within the paginated result set.

organization
string

Filter by organization ID.

name
string

Filter by name.

type
string (ProjectTypeEnum)
Enum: "consortium" "public"

Filter by project type.

Responses

Response Schema: application/json
count
integer

Number of the objects in the paginated results.

next
string Nullable

Link to the next page.

previous
string Nullable

Link to the previous page.

Array of objects

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "previous": null,
  • "results":
    [
    ]
}

Create Project

Create a project.

Authorizations:
Request Body schema: application/json
name
required
string

Name of the project.

description
string

Description of the project.

type
string
Default: "consortium"
Enum: "consortium" "public"

Type of the project.

Responses

Response Schema: application/json
id
string
name
string

Name of the project.

description
string

Description of the project.

type
string
Default: "consortium"
Enum: "consortium" "public"

Type of the project.

members
integer

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

networks
integer

Number of networks created in the project.

object

Creator of the project.

created_at
string <date-time>

When the project was created.

Request samples

Content type
application/json
Example
{
  • "name": "My consortium project",
  • "description": "My consortium project description"
}

Response samples

Content type
application/json
Example
{
  • "id": "PR-123-456",
  • "name": "My consortium project",