Chainstack API (v1)

Download OpenAPI specification:Download

API Support: [email protected]

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

Application

List all Applications

List all applications.

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

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

page
integer

A page number within the paginated result set.

node
string

Filter by node ID.

status
string (ApplicationStatusEnum)
Enum: "installing" "installed" "failed" "deleting"

Filter by application status.

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": 2,
  • "next": null,
  • "previous": null,
  • "results":
    [
    ]
}

Create Application

Create an application.

Authorizations:
Request Body schema: multipart/form-data
type
required
string (ApplicationTypeEnum)
Value: "cordapp"

Type of the application.
Available types:

  • cordapp — only for corda nodes
required
CordaApplicationCreateConfiguration (object)

Application-type specific parameters.
Pass {} if there are no specific parameters for the chosen application type.

Responses

Response Schema: application/json
id
string
name
string

Name of the application.

type
string (ApplicationTypeEnum)
Value: "cordapp"

Type of the application.
Available types:

  • cordapp — only for corda nodes
CordaApplicationDetails (object) (ApplicationDetails)
status
string (ApplicationStatusEnum)
Enum: "installing" "installed" "failed" "deleting"

Status of the application.

object

Creator of the application.

created_at
string <date-time>

When the application was created.

CordaApplicationConfiguration (object) (ApplicationConfiguration)

Request samples

curl --location --request POST 'https://api.chainstack.com/public/v1/applications' \
--header 'Authorization: Bearer FX7CWlLg.FMpAO8cgCX2N7s41EncRru2nb5CmTZUt' \
--form 'type="cordapp"' \
--form 'configuration.node="ND-123-456-789"' \
--form '[email protected]"./heartbeat-1.0.jar"'

Response samples