Skip to main content
GET
Get Dockerfile

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Path Parameters

id
string<uuid>
required

Application identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

dockerfile_id
string<uuid>
required

Dockerfile identifier, as returned in dockerfile_id of a deployment

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

Response

Default Response

id
string<uuid>
required

Unique identifier for the Dockerfile version

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

app_id
string<uuid>
required

Identifier of the application the Dockerfile belongs to

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

version
integer
required

Version number of the Dockerfile within its application, starting at 1. A new version is recorded only when a build uses a Dockerfile, .dockerignore or source that differs from the latest version. Otherwise the build reuses the latest version and updates its language, facts and processes to what Ingot detected, unless Ingot detected nothing.

Required range: 1 <= x <= 9007199254740991
Example:

3

source
enum<string>
required

Where the Dockerfile comes from: ingot - generated by Sevalla with Ingot for an application built with ingot; user - the Dockerfile from your repository, for an application built with dockerfile

Available options:
ingot,
user
Example:

"ingot"

dockerfile
string
required

Content of the Dockerfile

Example:

"FROM node:22-slim AS build"

dockerignore
string | null
required

Content of the .dockerignore the build used. For user Dockerfiles this is <Dockerfile>.dockerignore next to the Dockerfile, or else .dockerignore in the build context, the same file Docker picks. Null when there is none.

Example:

"node_modules"

ingot_version
string | null
required

Version of Ingot that first generated this Dockerfile. When it differs from the previous version, the change may come from an Ingot upgrade rather than from the application. Null for user Dockerfiles.

Example:

"v0.3.2"

language
string | null
required

Language Ingot detected in the application source, such as node, python, php, go, ruby, rust, java, dotnet, elixir, deno, gleam, zig, cpp, static (a static site) or shell (a start.sh script). For user Dockerfiles it is detected from the repository and does not come from your Dockerfile. Null when Ingot could not detect the application, and for versions recorded before this field existed.

Example:

"php"

facts
object[]
required

What Ingot detected about the application, such as its framework, runtime version and package manager, each with the file it came from. For ingot Dockerfiles these are the decisions listed in the Dockerfile header. Empty when language is null.

processes
object[]
required

Processes Ingot recommends running from the same image besides the web process, such as queue workers, schedulers or database migrations. These are suggestions and are not created for you.

created_at
string<date-time>
required

Timestamp when the Dockerfile version was first recorded, in ISO 8601 format

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2025-01-30T00:00:00.000Z"