Skip to main content
POST
/
environment
/
{environmentId}
/
checkDockerfile
Check dockerfile configuration is correct
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/checkDockerfile \
  --header 'Authorization: <api-key>' \
  --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",
    "provider": "BITBUCKET"
  },
  "dockerfile_path": "<string>"
}'
{
  "dockerfile_path": "<string>",
  "arg": [
    "<string>"
  ],
  "repositories": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

environmentId
string<uuid>
required

Environment ID

Body

application/json
git_repository
object
required
dockerfile_path
string
required

path of the dockerfile with root_path as base path

Response

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