Check dockerfile configuration is correct

POST /environment/{environmentId}/checkDockerfile

Check dockerfile configuration is correct

cURL

curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/checkDockerfile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "git_repository": {
    "url": "https://github.com/Qovery/simple-node-app",
    "branch": "feat/text_xxx",
    "root_path": "/",
    "git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "dockerfile_path": "<string>"
}
'

import requests

url = "https://api.qovery.com/environment/{environmentId}/checkDockerfile"

payload = {
    "git_repository": {
        "url": "https://github.com/Qovery/simple-node-app",
        "branch": "feat/text_xxx",
        "root_path": "/",
        "git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "dockerfile_path": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    git_repository: {
      url: 'https://github.com/Qovery/simple-node-app',
      branch: 'feat/text_xxx',
      root_path: '/',
      git_token_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    },
    dockerfile_path: '<string>'
  })
};

fetch('https://api.qovery.com/environment/{environmentId}/checkDockerfile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/environment/{environmentId}/checkDockerfile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'git_repository' => [
        'url' => 'https://github.com/Qovery/simple-node-app',
        'branch' => 'feat/text_xxx',
        'root_path' => '/',
        'git_token_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'dockerfile_path' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/environment/{environmentId}/checkDockerfile"

	payload := strings.NewReader("{\n  \"git_repository\": {\n    \"url\": \"https://github.com/Qovery/simple-node-app\",\n    \"branch\": \"feat/text_xxx\",\n    \"root_path\": \"/\",\n    \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"dockerfile_path\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.qovery.com/environment/{environmentId}/checkDockerfile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"git_repository\": {\n    \"url\": \"https://github.com/Qovery/simple-node-app\",\n    \"branch\": \"feat/text_xxx\",\n    \"root_path\": \"/\",\n    \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"dockerfile_path\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/environment/{environmentId}/checkDockerfile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"git_repository\": {\n    \"url\": \"https://github.com/Qovery/simple-node-app\",\n    \"branch\": \"feat/text_xxx\",\n    \"root_path\": \"/\",\n    \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"dockerfile_path\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "dockerfile_path": "<string>",
  "arg": [
    "<string>"
  ],
  "repositories": [
    "<string>"
  ]
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

environmentId · string<uuid> · required

Environment ID

Body

application/json

git_repository · object · required

Show child attributes

dockerfile_path · string · required

path of the dockerfile with root_path as base path

Response

200

application/json

Information about the dockerfile

dockerfile_path · string · required

arg · string[]

All ARG variable declared in the Dockerfile

repositories · string[]

All image repositories we found declared in the Dockerfile