[READ ME FIRST] Getting started with the Beta

Hey :wave:,

Because you are the best - now, you have access to the Qovery v2 Beta before anyone else :partying_face:.

-==============================-
:fire:To get access to the Qovery v2 Beta, click here.:fire:
-==============================-

:warning: To use the v1 go to https://console-v1.qovery.com

Here are a few things to keep in mind:

  1. It’s a closed beta - so please don’t share the link with anyone :slightly_smiling_face:
  2. The product is still in development, and you’ll face bugs. So if you encounter one of them, let us know here - then we will prioritize those bugs. - to report bugs, please use this private forum section.
  3. Some features like environment variables and logs are not available now, but they will in the coming days.
  4. Have fun. You can explore and play with the API as well. The documentation is > https://api-doc.qovery.com
  5. Any product suggestions? You can make the request through this beta forum as well.

Workarounds

Here is a list of workarounds before we can give access to features under development.

Database

Get master credentials

curl -X GET 'https://api.qovery.com/database/<your_database_id>/masterCredentials' \
--header 'Authorization: Bearer <your_token>'

Environment variable

The examples from below are for the ENVIRONMENT scope, but you can also attach variables to PROJECT and APPLICATION.

List

curl -X GET 'https://api.qovery.com/environment/<your_environment_id>/environmentVariable' \
--header 'Authorization: Bearer <your_token>'

Add

curl -X POST 'https://api.qovery.com/environment/<your_environment_id>/environmentVariable' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_token>' \
--data-raw '{
    "key": "idLoremexeu",
    "value": "enim sunt aliqua magna"
}'

Delete

curl -X DELETE 'https://api.qovery.com/environment/<your_environment_id>/environmentVariable/<your_variable_id>' \
--header 'Authorization: Bearer <your_token>'

Secret

The examples from below are for the ENVIRONMENT scope, but you can also attach secrets to PROJECT and APPLICATION .

List

curl -X GET 'https://api.qovery.com/environment/<your_environment_id>/secret' \
--header 'Authorization: Bearer <your_token>'

Add

curl -X POST 'https://api.qovery.com/environment/<your_environment_id>/secret' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_token>' \
--data-raw '{
    "key": "idLoremexeu",
    "value": "enim sunt aliqua magna"
}'

Delete

curl -X DELETE 'https://api.qovery.com/environment/<your_environment_id>/secret/<your_variable_id>' \
--header 'Authorization: Bearer <your_token>'

Get current credits

read the API documentation.

curl -X GET 'https://api.qovery.com/organization/<organization_id>/currentCost' \
--header 'Authorization: Bearer <your_token>'
{
  "billing_started_on": "2019-08-24T14:15:22Z",
  "billing_ended_on": "2019-08-24T14:15:22Z",
  "budget_exceeded": true,
  "remaining_credits": {
    "total_in_cents": 30000,
    "total": 300,
    "currency_code": "USD"
  },
  "cost": {
    "total_in_cents": 30000,
    "total": 300,
    "currency_code": "USD"
  },
  "budget_threshold": {
    "total_in_cents": 30000,
    "total": 300,
    "currency_code": "USD"
  },
  "projects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "billing_started_on": "2019-08-24T14:15:22Z",
      "billing_ended_on": "2019-08-24T14:15:22Z",
      "consumed_time_in_seconds": 3600,
      "cost": {
        "total_in_cents": 30000,
        "total": 300,
        "currency_code": "USD"
      },
      "environments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "billing_started_on": "2019-08-24T14:15:22Z",
          "billing_ended_on": "2019-08-24T14:15:22Z",
          "consumed_time_in_seconds": 3600,
          "cost": {
            "total_in_cents": 30000,
            "total": 300,
            "currency_code": "USD"
          }
        }
      ]
    }
  ]
}

Here the remaining credits indicate that it remains $300 credits on your Organization.


Q&A

What tool can you use to report a bug?

I would recommend using:

  • Loom to report a bug. It gives the whole context and makes your life easier.
  • Skitch to make screenshots and easily hide sensitive information.

How to get your authentication token?

  1. Open your browser.
  2. Connect to console-beta.qovery.com.
  3. Open your browser debugger.
  4. Click on the network tab.
  5. Find a request made to api.qovery.com and copy the authorization header token.

This is a temporary way to get authentication tokens until we provide a Machine-To-Machine way.

How to find your environment id?

How to find your application id?

Same as for the environment, but for the application. Look at the URL and take the ID on the right of .../application/.

How to find your database id?

Same as for the application, but for the database. Look at the URL and take the ID on the right of .../database/.