---
title: "Check dockerfile configuration is correct"
method: POST
path: "/environment/{environmentId}/checkDockerfile"
tags: ["Environment"]
---

# Check dockerfile configuration is correct

`POST /environment/{environmentId}/checkDockerfile`

## Request

- Base URL: `https://api.qovery.com`
- URL: `https://api.qovery.com/environment/{environmentId}/checkDockerfile`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/qovery/apis/qovery-api/docs/environment/:environmentId/checkDockerfile/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `environmentId` string, uuid, required

## Request body

- DockerfileCheckRequest
  - `git_repository` ApplicationGitRepositoryRequest, required
    - `url` string, required: application git repository URL
    - `branch` string: Name of the branch to use. This is optional If not specified, then the branch used is the `main` or `master` one
    - `root_path` string: indicates the root path of the application.
    - `git_token_id` string, uuid, nullable: The git token id on Qovery side
    - `provider` 'BITBUCKET' | 'GITHUB' | 'GITLAB', required
  - `dockerfile_path` string, required: path of the dockerfile with root_path as base path

## Response `200`

Information about the dockerfile

- DockerfileCheckResponse
  - `dockerfile_path` string, required
  - `arg` string[]: All ARG variable declared in the Dockerfile
  - `repositories` string[]: All image repositories we found declared in the Dockerfile

## Other responses

- `400`: Bad request
- `401`: Access token is missing or invalid
- `403`: Access forbidden
- `404`: Resource not found

---

[API](https://skmtc.dev/qovery/apis/qovery-api.md) - [All operations](https://skmtc.dev/qovery/apis/qovery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/qovery/apis/qovery-api/revisions/93c4960a44ba?raw)