Download OpenAPI specification:Download
A set of API endpoints to operate and manage the platform resources.
See also a quick API tutorial.
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 |
List all applications.
order_by | string Enum: "name" "created_at" Which field to use when ordering the results.
|
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. |
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 |
{- "count": 2,
- "next": null,
- "previous": null,
- "results": [
- {
- "id": "CA-123-456-789",
- "name": "My CorDapp",
- "status": "installed",
- "type": "cordapp",
- "configuration": {
- "node": "ND-123-456-789"
}, - "details": {
- "cordapp_type": "workflow",
- "version": 1579870483,
- "manifest": {
- "Sealed": true,
- "Manifest-Version": 1,
- "Min-Platform-Version": 4,
- "Cordapp-Workflow-Name": "My workflow",
- "Cordapp-Workflow-Vendor": "Chainstack",
- "Target-Platform-Version": 4,
- "Cordapp-Workflow-Licence": "Apache License, Version 2.0",
- "Cordapp-Workflow-Version": 123456789
}
}, - "created_at": "2020-06-15T07:38:00.747Z",
- "creator": {
- "id": "UR-111-111-111",
- "first_name": "John",
- "last_name": "Smith",
- "organization": {
- "id": "RG-123-456",
- "name": "My organization"
}
}
}, - {
- "id": "CA-111-222-333",
- "name": "My combined CorDapp",
- "status": "installed",
- "type": "cordapp",
- "configuration": {
- "node": "ND-111-222-333"
}, - "details": {
- "cordapp_type": "combined",
- "version": "",
- "manifest": {
- "Sealed": true,
- "Manifest-Version": 1,
- "Min-Platform-Version": 4,
- "Cordapp-Contract-Name": "Contract",
- "Cordapp-Workflow-Name": "Workflow",
- "Cordapp-Contract-Vendor": "Chainstack",
- "Cordapp-Workflow-Vendor": "Chainstack",
- "Target-Platform-Version": 4,
- "Cordapp-Contract-Licence": "Apache License, Version 2.0",
- "Cordapp-Contract-Version": 1,
- "Cordapp-Workflow-Licence"": "Apache License, Version 2.0",
- "Cordapp-Workflow-Version": 1
}, - "entries": [
- {
- "name": "Contract",
- "version": 1,
- "cordapp_type": "contract"
}, - {
- "name": "Workflow",
- "version": 1,
- "cordapp_type": "workflow"
}
]
}, - "created_at": "2020-06-15T07:38:00.747Z",
- "creator": {
- "id": "UR-111-111-111",
- "first_name": "John",
- "last_name": "Smith",
- "organization": {
- "id": "RG-123-456",
- "name": "My organization"
}
}
}
]
}
Create an application.
type required | string (ApplicationTypeEnum) Value: "cordapp" Type of the application.
|
required | CordaApplicationCreateConfiguration (object) Application-type specific parameters.
|
id | string |
name | string Name of the application. |
type | string (ApplicationTypeEnum) Value: "cordapp" Type of the application.
|
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) |
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"'