- Make sure you have a valid Akash database first.
- Make sure you have a valid User database. If the user database is empty, the necessary tables will be created automatically.
- Create a
.envfile with the necessary environment variables. - Run
npm installto install dependencies. - Start the app with
npm start.
You can make sure the api is working by accessing the status endpoint: http://localhost:3080/status
When running the api locally the following environment variables can be set in a .env file.
| Name | Value | Note |
|---|---|---|
| Network | mainnet or testnet |
Specify if the api should be in mainnet or testnet mode. Default: mainnet. |
| RestApiNodeUrl | ex: "https://api.akashnet.net" |
Rest api to use. Will default to "https://rest.cosmos.directory/akash" for mainnet and "https://api.testnet-02.aksh.pw:443" for testnet. |
| HealthchecksEnabled | true or false |
Specify if the Scheduler should send health check pings. |
| SentryDSN | ex: "https://[email protected]/1234" |
Sentry DSN used when initializing Sentry |
| AkashDatabaseCS | ex: postgres://user:password@localhost:5432/cloudmos-akash |
Akash Database Connection String |
| AkashTestnetDatabaseCS | ex: postgres://user:password@localhost:5432/cloudmos-akash-testnet |
Akash Testnet Database Connection String |
| UserDatabaseCS | ex: postgres://user:password@localhost:5432/cloudmos-users |
User Database Connection String |
| Auth0JWKSUri | ex: 'https://1a2b3c.us.auth0.com/.well-known/jwks.json' |
|
| Auth0Audience | ex: 'https://api.cloudmos.io' |
|
| Auth0Issuer | ex: 'https://dev-5aprb0lr.us.auth0.com/' |
|
| Auth0Issuer | ex: 'https://auth.cloudmos.io/' |
|
| StripeSecretKey | ex: sk_test_12aw315wdawd3...293d12d32df8jf |
|
| WebsiteUrl | http://localhost:3001 |
The public api version will now be included in the url like so: api.cloudmos.io/v1/<endpoint>
Changes that are backward compatible like adding new endpoint will be done in the existing version. Changes that are not backward compatible, such as removing an endpoint, will be done in a new version. When releasing a new version, a list of breaking changes will be made available. We will keep the old version available for a while to give users enough time to migrate their applications to the latest version.
A swagger documentation is now available at https://api.cloudmos.io/v1/swagger. You can use it to see the list of available endpoints and try them directly in your browser.
The /api prefix was removed from every public endpoints and instead the version should be used (ex: /v1/<endpoint>)
Here is a list of endpoints that have changed in this release. Old endpoints will temporarily redirect to the new ones. In future releases, the versioning system will be used instead of redirects.
| Old | New |
|---|---|
/dashboardData |
/dashboard-data |
/getNetworkCapacity |
/network-capacity |
/getMainnetNodes |
/nodes/mainnet |
/getSandboxNodes |
/nodes/sandbox |
/getTestnetNodes |
/nodes/testnet |
/getProviderAttributesSchema |
/provider-attributes-schema |
/getMainnetVersion |
/version/mainnet |
/getSandboxVersion |
/version/sandbox |
/getTestnetVersion |
/version/testnet |
/getProviderGraphData/<dataName> |
/provider-graph-data/<dataName> |
/getProviderActiveLeasesGraphData/<address> |
/provider-active-leases-graph-data/<address> |
/getGraphData/<dataName> |
/graph-data/<dataName> |
/marketData |
/market-data |
/predicted-block-date/<height>/<blockWindow> |
/predicted-block-date/<height>?blockWindow=<blockWindow> |
/predicted-date-height/<timestamp>/<blockWindow> |
/predicted-date-height/<timestamp>?blockWindow=<blockWindow> |
/providers/<provider>/deployments/<skip>/<take>/<status> |
/providers/<provider>/deployments/<skip>/<take>?status=<status> |