Dagger GraphQL API Reference
Queries
cacheVolume
Description
Constructs a cache volume for a given cache key.
Type
Example
query {
cacheVolume(key: "deps") {
id
}
}
container
Description
Creates a scratch container, with no image or metadata.
To pull an image, follow up with the "from" function.
Type
Arguments
| Name | Description |
|---|---|
platform - Platform
|
Platform to initialize the container with. Defaults to the native platform of the current engine |
Example
query {
container {
from(address: "alpine") {
defaultArgs
entrypoint
platform
rootfs {
entries
}
}
}
}
currentFunctionCall
Description
The FunctionCall context that the SDK caller is currently executing in.
If the caller is not currently executing in a function, this will return an error.
Type
Example
currentModule
Description
The module currently being served in the session, if any.
Type
Example
currentTypeDefs
Description
The TypeDef representations of the objects currently being served in the session.
Type
Example
defaultPlatform
Description
The default platform of the engine.
Type
Example
query {
defaultPlatform
}
directory
Description
Creates an empty directory.
Type
Example
query {
directory {
withNewDirectory(path: "foo") {
withNewDirectory(path: "foo/bar/baz") {
withNewFile(path: "foo/bar/greeting", contents: "hello, world!\n") {
foo: entries(path: "foo")
bar: entries(path: "foo/bar")
greeting: file(path: "foo/bar/greeting") {
contents
}
}
}
}
}
}
engine
Description
The Dagger engine container configuration and state
Type
Example
env
Description
Initialize a new environment
Example
error
Description
Create a new error.
Example
function
Description
Creates a function.
Type
Arguments
| Name | Description |
|---|---|
name - String!
|
Name of the function, in its original format from the implementation language. |
returnType - TypeDefID!
|
Return type of the function. |
Example
generatedCode
Description
Create a code generation result, given a directory containing the generated code.
Type
Arguments
| Name | Description |
|---|---|
code - DirectoryID!
|
Example
git
Description
Queries a Git repository.
Type
Arguments
| Name | Description |
|---|---|
url - String!
|
URL of the git repository. Can be formatted as Suffix ".git" is optional. |
keepGitDir - Boolean
|
DEPRECATED: Set to true to keep .git directory. Default = true |
experimentalServiceHost - ServiceID
|
A service which must be started before the repo is fetched. |
sshKnownHosts - String
|
Set SSH known hosts. Default = "" |
sshAuthSocket - SocketID
|
Set SSH auth socket |
Example
query {
git(url: "https://github.com/dagger/dagger", keepGitDir: true) {
branch(name: "main") {
tree {
file(path: ".git/refs/heads/main") {
contents
}
}
}
}
}
host
Description
Queries the host environment.
Type
Example
query {
host {
read: directory(path: ".") {
file(path: ".markdownlint.yaml") {
contents
}
}
home: envVariable(name: "HOME") {
value
}
pwd: envVariable(name: "PWD") {
value
}
write: directory(path: ".") {
withNewFile(path: "greeting", contents: "Hello Dagger!") {
export(path: ".")
}
}
}
}
http
Description
Returns a file containing an http remote url content.
Type
Arguments
| Name | Description |
|---|---|
url - String!
|
HTTP url to get the content from (e.g., "https://docs.dagger.io"). |
experimentalServiceHost - ServiceID
|
A service which must be started before the URL is fetched. |
Example
query {
http(url: "http://dagger.io") {
size
contents
}
}
llm
Description
Initialize a Large Language Model (LLM)
Example
loadBindingFromID
Description
Load a Binding from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - BindingID!
|
Example
loadCacheVolumeFromID
Description
Load a CacheVolume from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - CacheVolumeID!
|
Example
loadContainerFromID
Description
Load a Container from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ContainerID!
|
Example
loadCurrentModuleFromID
Description
Load a CurrentModule from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - CurrentModuleID!
|
Example
loadDirectoryFromID
Description
Load a Directory from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - DirectoryID!
|
Example
loadEngineCacheEntryFromID
Description
Load a EngineCacheEntry from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - EngineCacheEntryID!
|
Example
loadEngineCacheEntrySetFromID
Description
Load a EngineCacheEntrySet from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - EngineCacheEntrySetID!
|
Example
loadEngineCacheFromID
Description
Load a EngineCache from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - EngineCacheID!
|
Example
loadEngineFromID
Description
Load a Engine from its ID.
Example
loadEnumTypeDefFromID
Description
Load a EnumTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - EnumTypeDefID!
|
Example
loadEnumValueTypeDefFromID
Description
Load a EnumValueTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - EnumValueTypeDefID!
|
Example
loadEnvFromID
Description
Load a Env from its ID.
Example
loadEnvVariableFromID
Description
Load a EnvVariable from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - EnvVariableID!
|
Example
loadErrorFromID
Description
Load a Error from its ID.
Example
loadErrorValueFromID
Description
Load a ErrorValue from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ErrorValueID!
|
Example
loadFieldTypeDefFromID
Description
Load a FieldTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - FieldTypeDefID!
|
Example
loadFileFromID
Description
Load a File from its ID.
Example
loadFunctionArgFromID
Description
Load a FunctionArg from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - FunctionArgID!
|
Example
loadFunctionCallArgValueFromID
Description
Load a FunctionCallArgValue from its ID.
Arguments
| Name | Description |
|---|---|
id - FunctionCallArgValueID!
|
Example
loadFunctionCallFromID
Description
Load a FunctionCall from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - FunctionCallID!
|
Example
loadFunctionFromID
Description
Load a Function from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - FunctionID!
|
Example
loadGeneratedCodeFromID
Description
Load a GeneratedCode from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - GeneratedCodeID!
|
Example
loadGitRefFromID
Description
Load a GitRef from its ID.
Example
loadGitRepositoryFromID
Description
Load a GitRepository from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - GitRepositoryID!
|
Example
loadHostFromID
Description
Load a Host from its ID.
Example
loadInputTypeDefFromID
Description
Load a InputTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - InputTypeDefID!
|
Example
loadInterfaceTypeDefFromID
Description
Load a InterfaceTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - InterfaceTypeDefID!
|
Example
loadLLMFromID
Description
Load a LLM from its ID.
Example
loadLLMTokenUsageFromID
Description
Load a LLMTokenUsage from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - LLMTokenUsageID!
|
Example
loadLabelFromID
Description
Load a Label from its ID.
Example
loadListTypeDefFromID
Description
Load a ListTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ListTypeDefID!
|
Example
loadModuleConfigClientFromID
Description
Load a ModuleConfigClient from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ModuleConfigClientID!
|
Example
loadModuleFromID
Description
Load a Module from its ID.
Example
loadModuleSourceFromID
Description
Load a ModuleSource from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ModuleSourceID!
|
Example
loadObjectTypeDefFromID
Description
Load a ObjectTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ObjectTypeDefID!
|
Example
loadPortFromID
Description
Load a Port from its ID.
Example
loadSDKConfigFromID
Description
Load a SDKConfig from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - SDKConfigID!
|
Example
loadScalarTypeDefFromID
Description
Load a ScalarTypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ScalarTypeDefID!
|
Example
loadSecretFromID
Description
Load a Secret from its ID.
Example
loadServiceFromID
Description
Load a Service from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - ServiceID!
|
Example
loadSocketFromID
Description
Load a Socket from its ID.
Example
loadSourceMapFromID
Description
Load a SourceMap from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - SourceMapID!
|
Example
loadTerminalFromID
Description
Load a Terminal from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - TerminalID!
|
Example
loadTypeDefFromID
Description
Load a TypeDef from its ID.
Type
Arguments
| Name | Description |
|---|---|
id - TypeDefID!
|
Example
module
Description
Create a new module.
Type
Example
moduleSource
Description
Create a new module source instance from a source ref string
Type
Arguments
| Name | Description |
|---|---|
refString - String!
|
The string ref representation of the module source |
refPin - String
|
The pinned version of the module source. Default = "" |
disableFindUp - Boolean
|
If true, do not attempt to find dagger.json in a parent directory of the provided path. Only relevant for local module sources. Default = false |
allowNotExists - Boolean
|
If true, do not error out if the provided ref string is a local path and does not exist yet. Useful when initializing new modules in directories that don't exist yet. Default = false |
requireKind - ModuleSourceKind
|
If set, error out if the ref string is not of the provided requireKind. |
Example
secret
Description
Creates a new secret.
Example
query {
secret(id: "eyJob3N0X2VudiI6IkhPTUUifQ==") {
plaintext
}
}
setSecret
Description
Sets a secret given a user defined name to its plaintext and returns the secret.
The plaintext value is limited to a size of 128000 bytes.
Example
sourceMap
Description
Creates source map metadata.
Type
Example
typeDef
Description
Create a new TypeDef.
Type
Example
version
Description
Get the current Dagger Engine version.
Type
Example
Types
Binding
Fields
| Field Name | Description |
|---|---|
asCacheVolume - CacheVolume! |
Retrieve the binding value, as type CacheVolume |
asContainer - Container! |
Retrieve the binding value, as type Container |
asDirectory - Directory! |
Retrieve the binding value, as type Directory |
asEnv - Env! |
Retrieve the binding value, as type Env |
asFile - File! |
Retrieve the binding value, as type File |
asGitRef - GitRef! |
Retrieve the binding value, as type GitRef |
asGitRepository - GitRepository! |
Retrieve the binding value, as type GitRepository |
asLLM - LLM! |
Retrieve the binding value, as type LLM |
asModule - Module! |
Retrieve the binding value, as type Module |
asModuleConfigClient - ModuleConfigClient! |
Retrieve the binding value, as type ModuleConfigClient |
asModuleSource - ModuleSource! |
Retrieve the binding value, as type ModuleSource |
asSecret - Secret! |
Retrieve the binding value, as type Secret |
asService - Service! |
Retrieve the binding value, as type Service |
asSocket - Socket! |
Retrieve the binding value, as type Socket |
digest - String! |
The digest of the binding value |
id - BindingID! |
A unique identifier for this Binding. |
name - String! |
The binding name |
typeName - String! |
The binding type |
BindingID
Description
The BindingID scalar type represents an identifier for an object of type Binding.
Boolean
Description
The Boolean scalar type represents true or false.
BuildArg
CacheSharingMode
Description
Sharing mode of the cache volume.
Values
| Enum Value | Description |
|---|---|
|
|
Shares the cache volume amongst many build pipelines |
|
|
Keeps a cache volume for a single build pipeline |
|
|
Shares the cache volume amongst many build pipelines, but will serialize the writes |
Example
"SHARED"
CacheVolume
Description
A directory whose contents persist across runs.
Fields
| Field Name | Description |
|---|---|
id - CacheVolumeID! |
A unique identifier for this CacheVolume. |
CacheVolumeID
Description
The CacheVolumeID scalar type represents an identifier for an object of type CacheVolume.
Container
Description
An OCI-compatible container, also known as a Docker container.
Fields
| Field Name | Description |
|---|---|
asService - Service! |
Turn the container into a Service. Be sure to set any exposed ports before this conversion. |
Arguments
|
|
asTarball - File! |
Package the container state as an OCI image, and return it as a tar archive |
Arguments
|
|
build - Container! |
Initializes this container from a Dockerfile build. |
Arguments
|
|
defaultArgs - [String!]! |
Return the container's default arguments. |
directory - Directory! |
Retrieve a directory from the container's root filesystem Mounts are included. |
entrypoint - [String!]! |
Return the container's OCI entrypoint. |
envVariable - String |
Retrieves the value of the specified environment variable. |
Arguments
|
|
envVariables - [EnvVariable!]! |
Retrieves the list of environment variables passed to commands. |
exitCode - Int! |
The exit code of the last executed command Returns an error if no command was executed |
experimentalWithAllGPUs - Container! |
EXPERIMENTAL API! Subject to change/removal at any time. Configures all available GPUs on the host to be accessible to this container. This currently works for Nvidia devices only. |
experimentalWithGPU - Container! |
EXPERIMENTAL API! Subject to change/removal at any time. Configures the provided list of devices to be accessible to this container. This currently works for Nvidia devices only. |
Arguments
|
|
export - String! |
Writes the container as an OCI tarball to the destination file path on the host. It can also export platform variants. |
Arguments
|
|
exposedPorts - [Port!]! |
Retrieves the list of exposed ports. This includes ports already exposed by the image, even if not explicitly added with dagger. |
file - File! |
Retrieves a file at the given path. Mounts are included. |
from - Container! |
Download a container image, and apply it to the container state. All previous state will be lost. |
Arguments
|
|
id - ContainerID! |
A unique identifier for this Container. |
imageRef - String! |
The unique image reference which can only be retrieved immediately after the 'Container.From' call. |
import - Container! |
Reads the container from an OCI tarball. |
label - String |
Retrieves the value of the specified label. |
Arguments
|
|
labels - [Label!]! |
Retrieves the list of labels passed to container. |
mounts - [String!]! |
Retrieves the list of paths where a directory is mounted. |
platform - Platform! |
The platform this container executes and publishes as. |
publish - String! |
Package the container state as an OCI image, and publish it to a registry Returns the fully qualified address of the published image, with digest |
Arguments
|
|
rootfs - Directory! |
Return a snapshot of the container's root filesystem. The snapshot can be modified then written back using withRootfs. Use that method for filesystem modifications. |
stderr - String! |
The buffered standard error stream of the last executed command Returns an error if no command was executed |
stdout - String! |
The buffered standard output stream of the last executed command Returns an error if no command was executed |
sync - ContainerID! |
Forces evaluation of the pipeline in the engine. It doesn't run the default command if no exec has been set. |
terminal - Container! |
Opens an interactive terminal for this container using its configured default terminal command if not overridden by args (or sh as a fallback default). |
Arguments
|
|
up - Void |
Starts a Service and creates a tunnel that forwards traffic from the caller's network to that service. Be sure to set any exposed ports before calling this api. |
Arguments
|
|
user - String! |
Retrieves the user to be set for all commands. |
withAnnotation - Container! |
Retrieves this container plus the given OCI anotation. |
withDefaultArgs - Container! |
Configures default arguments for future commands. Like CMD in Dockerfile. |
Arguments
|
|
withDefaultTerminalCmd - Container! |
Set the default command to invoke for the container's terminal API. |
Arguments
|
|
withDirectory - Container! |
Return a new container snapshot, with a directory added to its filesystem |
Arguments
|
|
withEntrypoint - Container! |
Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default. |
Arguments
|
|
withEnvVariable - Container! |
Set a new environment variable in the container. |
withExec - Container! |
Execute a command in the container, and return a new snapshot of the container state after execution. |
Arguments
|
|
withExposedPort - Container! |
Expose a network port. Like EXPOSE in Dockerfile (but with healthcheck support) Exposed ports serve two purposes:
|
Arguments
|
|
withFile - Container! |
Return a container snapshot with a file added |
Arguments
|
|
withFiles - Container! |
Retrieves this container plus the contents of the given files copied to the given path. |
Arguments
|
|
withLabel - Container! |
Retrieves this container plus the given label. |
withMountedCache - Container! |
Retrieves this container plus a cache volume mounted at the given path. |
Arguments
|
|
withMountedDirectory - Container! |
Retrieves this container plus a directory mounted at the given path. |
Arguments
|
|
withMountedFile - Container! |
Retrieves this container plus a file mounted at the given path. |
Arguments
|
|
withMountedSecret - Container! |
Retrieves this container plus a secret mounted into a file at the given path. |
Arguments
|
|
withMountedTemp - Container! |
Retrieves this container plus a temporary directory mounted at the given path. Any writes will be ephemeral to a single withExec call; they will not be persisted to subsequent withExecs. |
withNewFile - Container! |
Return a new container snapshot, with a file added to its filesystem |
Arguments
|
|
withRegistryAuth - Container! |
Attach credentials for future publishing to a registry. Use in combination with publish |
Arguments |
|
withRootfs - Container! |
Change the container's root filesystem. The previous root filesystem will be lost. |
Arguments
|
|
withSecretVariable - Container! |
Set a new environment variable, using a secret value |
withServiceBinding - Container! |
Establish a runtime dependency on a from a container to a network service. The service will be started automatically when needed and detached when it is no longer needed, executing the default command if none is set. The service will be reachable from the container via the provided hostname alias. The service dependency will also convey to any files or directories produced by the container. |
Arguments
|
|
withUnixSocket - Container! |
Retrieves this container plus a socket forwarded to the given Unix socket path. |
Arguments
|
|
withUser - Container! |
Retrieves this container with a different command user. |
Arguments
|
|
withWorkdir - Container! |
Change the container's working directory. Like WORKDIR in Dockerfile. |
withoutAnnotation - Container! |
Retrieves this container minus the given OCI annotation. |
Arguments
|
|
withoutDefaultArgs - Container! |
Remove the container's default arguments. |
withoutDirectory - Container! |
Return a new container snapshot, with a directory removed from its filesystem |
withoutEntrypoint - Container! |
Reset the container's OCI entrypoint. |
Arguments
|
|
withoutEnvVariable - Container! |
Retrieves this container minus the given environment variable. |
Arguments
|
|
withoutExposedPort - Container! |
Unexpose a previously exposed port. |
Arguments
|
|
withoutFile - Container! |
Retrieves this container with the file at the given path removed. |
withoutFiles - Container! |
Return a new container spanshot with specified files removed |
Arguments
|
|
withoutLabel - Container! |
Retrieves this container minus the given environment label. |
Arguments
|
|
withoutMount - Container! |
Retrieves this container after unmounting everything at the given path. |
withoutRegistryAuth - Container! |
Retrieves this container without the registry authentication of a given address. |
Arguments
|
|
withoutSecretVariable - Container! |
Retrieves this container minus the given environment variable containing the secret. |
Arguments
|
|
withoutUnixSocket - Container! |
Retrieves this container with a previously added Unix socket removed. |
withoutUser - Container! |
Retrieves this container with an unset command user. Should default to root. |
withoutWorkdir - Container! |
Unset the container's working directory. Should default to "/". |
workdir - String! |
Retrieves the working directory for all commands. |
ContainerID
Description
The ContainerID scalar type represents an identifier for an object of type Container.
CurrentModule
Description
Reflective module API provided to functions at runtime.
Fields
| Field Name | Description |
|---|---|
id - CurrentModuleID! |
A unique identifier for this CurrentModule. |
name - String! |
The name of the module being executed in |
source - Directory! |
The directory containing the module's source code loaded into the engine (plus any generated code that may have been created). |
workdir - Directory! |
Load a directory from the module's scratch working directory, including any changes that may have been made to it during module function execution. |
workdirFile - File! |
Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution. |
Arguments
|
|
CurrentModuleID
Description
The CurrentModuleID scalar type represents an identifier for an object of type CurrentModule.
Directory
Description
A directory.
Fields
| Field Name | Description |
|---|---|
asGit - GitRepository! |
Converts this directory to a local git repository |
asModule - Module! |
Load the directory as a Dagger module source |
Arguments
|
|
asModuleSource - ModuleSource! |
Load the directory as a Dagger module source |
Arguments
|
|
diff - Directory! |
Return the difference between this directory and an another directory. The difference is encoded as a directory. |
Arguments
|
|
digest - String! |
Return the directory's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine. |
directory - Directory! |
Retrieves a directory at the given path. |
Arguments
|
|
dockerBuild - Container! |
Use Dockerfile compatibility to build a container from this directory. Only use this function for Dockerfile compatibility. Otherwise use the native Container type directly, it is feature-complete and supports all Dockerfile features. |
Arguments
|
|
entries - [String!]! |
Returns a list of files and directories at the given path. |
Arguments
|
|
export - String! |
Writes the contents of the directory to a path on the host. |
Arguments
|
|
file - File! |
Retrieve a file at the given path. |
Arguments
|
|
filter - Directory! |
Return a snapshot with some paths included or excluded |
Arguments |
|
glob - [String!]! |
Returns a list of files and directories that matche the given pattern. |
Arguments
|
|
id - DirectoryID! |
A unique identifier for this Directory. |
name - String! |
Returns the name of the directory. |
sync - DirectoryID! |
Force evaluation in the engine. |
terminal - Directory! |
Opens an interactive terminal in new container with this directory mounted inside. |
Arguments
|
|
withDirectory - Directory! |
Return a snapshot with a directory added |
Arguments
|
|
withFile - Directory! |
Retrieves this directory plus the contents of the given file copied to the given path. |
withFiles - Directory! |
Retrieves this directory plus the contents of the given files copied to the given path. |
Arguments
|
|
withNewDirectory - Directory! |
Retrieves this directory plus a new directory created at the given path. |
withNewFile - Directory! |
Return a snapshot with a new file added |
withTimestamps - Directory! |
Retrieves this directory with all file/dir timestamps set to the given time. |
Arguments
|
|
withoutDirectory - Directory! |
Return a snapshot with a subdirectory removed |
Arguments
|
|
withoutFile - Directory! |
Return a snapshot with a file removed |
Arguments
|
|
withoutFiles - Directory! |
Return a snapshot with files removed |
Arguments
|
|
DirectoryID
Description
The DirectoryID scalar type represents an identifier for an object of type Directory.
Engine
Description
The Dagger engine configuration and state
Fields
| Field Name | Description |
|---|---|
id - EngineID! |
A unique identifier for this Engine. |
localCache - EngineCache! |
The local (on-disk) cache for the Dagger engine |
EngineCache
Description
A cache storage for the Dagger engine
Fields
| Field Name | Description |
|---|---|
entrySet - EngineCacheEntrySet! |
The current set of entries in the cache |
Arguments
|
|
id - EngineCacheID! |
A unique identifier for this EngineCache. |
keepBytes - Int! |
The maximum bytes to keep in the cache without pruning, after which automatic pruning may kick in. Use minFreeSpace instead. |
maxUsedSpace - Int! |
The maximum bytes to keep in the cache without pruning. |
minFreeSpace - Int! |
The target amount of free disk space the garbage collector will attempt to leave. |
prune - Void |
Prune the cache of releaseable entries |
reservedSpace - Int! |
|
EngineCacheEntry
Description
An individual cache entry in a cache entry set
Fields
| Field Name | Description |
|---|---|
activelyUsed - Boolean! |
Whether the cache entry is actively being used. |
createdTimeUnixNano - Int! |
The time the cache entry was created, in Unix nanoseconds. |
description - String! |
The description of the cache entry. |
diskSpaceBytes - Int! |
The disk space used by the cache entry. |
id - EngineCacheEntryID! |
A unique identifier for this EngineCacheEntry. |
mostRecentUseTimeUnixNano - Int! |
The most recent time the cache entry was used, in Unix nanoseconds. |
EngineCacheEntryID
Description
The EngineCacheEntryID scalar type represents an identifier for an object of type EngineCacheEntry.
EngineCacheEntrySet
Description
A set of cache entries returned by a query to a cache
Fields
| Field Name | Description |
|---|---|
diskSpaceBytes - Int! |
The total disk space used by the cache entries in this set. |
entries - [EngineCacheEntry!]! |
The list of individual cache entries in the set |
entryCount - Int! |
The number of cache entries in this set. |
id - EngineCacheEntrySetID! |
A unique identifier for this EngineCacheEntrySet. |
EngineCacheEntrySetID
Description
The EngineCacheEntrySetID scalar type represents an identifier for an object of type EngineCacheEntrySet.
EngineCacheID
Description
The EngineCacheID scalar type represents an identifier for an object of type EngineCache.
EngineID
Description
The EngineID scalar type represents an identifier for an object of type Engine.
EnumTypeDef
Description
A definition of a custom enum defined in a Module.
Fields
| Field Name | Description |
|---|---|
description - String! |
A doc string for the enum, if any. |
id - EnumTypeDefID! |
A unique identifier for this EnumTypeDef. |
name - String! |
The name of the enum. |
sourceMap - SourceMap! |
The location of this enum declaration. |
sourceModuleName - String! |
If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise. |
values - [EnumValueTypeDef!]! |
The values of the enum. |
EnumTypeDefID
Description
The EnumTypeDefID scalar type represents an identifier for an object of type EnumTypeDef.
EnumValueTypeDef
Description
A definition of a value in a custom enum defined in a Module.
Fields
| Field Name | Description |
|---|---|
description - String! |
A doc string for the enum value, if any. |
id - EnumValueTypeDefID! |
A unique identifier for this EnumValueTypeDef. |
name - String! |
The name of the enum value. |
sourceMap - SourceMap! |
The location of this enum value declaration. |
EnumValueTypeDefID
Description
The EnumValueTypeDefID scalar type represents an identifier for an object of type EnumValueTypeDef.
Env
Fields
| Field Name | Description |
|---|---|
id - EnvID! |
A unique identifier for this Env. |
input - Binding! |
retrieve an input value by name |
Arguments
|
|
inputs - [Binding!]! |
return all input values for the environment |
output - Binding! |
retrieve an output value by name |
Arguments
|
|
outputs - [Binding!]! |
return all output values for the environment |
withCacheVolumeInput - Env! |
Create or update a binding of type CacheVolume in the environment |
Arguments
|
|
withCacheVolumeOutput - Env! |
Declare a desired CacheVolume output to be assigned in the environment |
withContainerInput - Env! |
Create or update a binding of type Container in the environment |
Arguments
|
|
withContainerOutput - Env! |
Declare a desired Container output to be assigned in the environment |
withDirectoryInput - Env! |
Create or update a binding of type Directory in the environment |
Arguments
|
|
withDirectoryOutput - Env! |
Declare a desired Directory output to be assigned in the environment |
withEnvInput - Env! |
Create or update a binding of type Env in the environment |
withEnvOutput - Env! |
Declare a desired Env output to be assigned in the environment |
withFileInput - Env! |
Create or update a binding of type File in the environment |
withFileOutput - Env! |
Declare a desired File output to be assigned in the environment |
withGitRefInput - Env! |
Create or update a binding of type GitRef in the environment |
withGitRefOutput - Env! |
Declare a desired GitRef output to be assigned in the environment |
withGitRepositoryInput - Env! |
Create or update a binding of type GitRepository in the environment |
Arguments
|
|
withGitRepositoryOutput - Env! |
Declare a desired GitRepository output to be assigned in the environment |
withLLMInput - Env! |
Create or update a binding of type LLM in the environment |
withLLMOutput - Env! |
Declare a desired LLM output to be assigned in the environment |
withModuleConfigClientInput - Env! |
Create or update a binding of type ModuleConfigClient in the environment |
Arguments
|
|
withModuleConfigClientOutput - Env! |
Declare a desired ModuleConfigClient output to be assigned in the environment |
withModuleInput - Env! |
Create or update a binding of type Module in the environment |
withModuleOutput - Env! |
Declare a desired Module output to be assigned in the environment |
withModuleSourceInput - Env! |
Create or update a binding of type ModuleSource in the environment |
Arguments
|
|
withModuleSourceOutput - Env! |
Declare a desired ModuleSource output to be assigned in the environment |
withSecretInput - Env! |
Create or update a binding of type Secret in the environment |
withSecretOutput - Env! |
Declare a desired Secret output to be assigned in the environment |
withServiceInput - Env! |
Create or update a binding of type Service in the environment |
Arguments
|
|
withServiceOutput - Env! |
Declare a desired Service output to be assigned in the environment |
withSocketInput - Env! |
Create or update a binding of type Socket in the environment |
withSocketOutput - Env! |
Declare a desired Socket output to be assigned in the environment |
withStringInput - Env! |
Create or update an input value of type string |
EnvID
Description
The EnvID scalar type represents an identifier for an object of type Env.
EnvVariable
EnvVariableID
Description
The EnvVariableID scalar type represents an identifier for an object of type EnvVariable.
Error
ErrorID
Description
The ErrorID scalar type represents an identifier for an object of type Error.
ErrorValue
ErrorValueID
Description
The ErrorValueID scalar type represents an identifier for an object of type ErrorValue.
FieldTypeDef
Description
A definition of a field on a custom object defined in a Module.
A field on an object has a static value, as opposed to a function on an object whose value is computed by invoking code (and can accept arguments).
Fields
| Field Name | Description |
|---|---|
description - String! |
A doc string for the field, if any. |
id - FieldTypeDefID! |
A unique identifier for this FieldTypeDef. |
name - String! |
The name of the field in lowerCamelCase format. |
sourceMap - SourceMap! |
The location of this field declaration. |
typeDef - TypeDef! |
The type of the field. |
FieldTypeDefID
Description
The FieldTypeDefID scalar type represents an identifier for an object of type FieldTypeDef.
File
Description
A file.
Fields
| Field Name | Description |
|---|---|
contents - String! |
Retrieves the contents of the file. |
digest - String! |
Return the file's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine. |
Arguments
|
|
export - String! |
Writes the file to a file path on the host. |
id - FileID! |
A unique identifier for this File. |
name - String! |
Retrieves the name of the file. |
size - Int! |
Retrieves the size of the file, in bytes. |
sync - FileID! |
Force evaluation in the engine. |
withName - File! |
Retrieves this file with its name set to the given name. |
Arguments
|
|
withTimestamps - File! |
Retrieves this file with its created/modified timestamps set to the given time. |
Arguments
|
|
FileID
Description
The FileID scalar type represents an identifier for an object of type File.
Function
Description
Function represents a resolver provided by a Module.
A function always evaluates against a parent object and is given a set of named arguments.
Fields
| Field Name | Description |
|---|---|
args - [FunctionArg!]! |
Arguments accepted by the function, if any. |
description - String! |
A doc string for the function, if any. |
id - FunctionID! |
A unique identifier for this Function. |
name - String! |
The name of the function. |
returnType - TypeDef! |
The type returned by the function. |
sourceMap - SourceMap! |
The location of this function declaration. |
withArg - Function! |
Returns the function with the provided argument |
Arguments
|
|
withDescription - Function! |
Returns the function with the given doc string. |
Arguments
|
|
withSourceMap - Function! |
Returns the function with the given source map. |
Arguments
|
|
FunctionArg
Description
An argument accepted by a function.
This is a specification for an argument at function definition time, not an argument passed at function call time.
Fields
| Field Name | Description |
|---|---|
defaultPath - String! |
Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory |
defaultValue - JSON! |
A default value to use for this argument when not explicitly set by the caller, if any. |
description - String! |
A doc string for the argument, if any. |
id - FunctionArgID! |
A unique identifier for this FunctionArg. |
ignore - [String!]! |
Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner. |
name - String! |
The name of the argument in lowerCamelCase format. |
sourceMap - SourceMap! |
The location of this arg declaration. |
typeDef - TypeDef! |
The type of the argument. |
FunctionArgID
Description
The FunctionArgID scalar type represents an identifier for an object of type FunctionArg.
FunctionCall
Description
An active function call.
Fields
| Field Name | Description |
|---|---|
id - FunctionCallID! |
A unique identifier for this FunctionCall. |
inputArgs - [FunctionCallArgValue!]! |
The argument values the function is being invoked with. |
name - String! |
The name of the function being called. |
parent - JSON! |
The value of the parent object of the function being called. If the function is top-level to the module, this is always an empty object. |
parentName - String! |
The name of the parent object of the function being called. If the function is top-level to the module, this is the name of the module. |
returnError - Void |
Return an error from the function. |
Arguments
|
|
returnValue - Void |
Set the return value of the function call to the provided value. |
Arguments
|
|
FunctionCallArgValue
FunctionCallArgValueID
Description
The FunctionCallArgValueID scalar type represents an identifier for an object of type FunctionCallArgValue.
FunctionCallID
Description
The FunctionCallID scalar type represents an identifier for an object of type FunctionCall.
FunctionID
Description
The FunctionID scalar type represents an identifier for an object of type Function.
GeneratedCode
Description
The result of running an SDK's codegen.
Fields
| Field Name | Description |
|---|---|
code - Directory! |
The directory containing the generated code. |
id - GeneratedCodeID! |
A unique identifier for this GeneratedCode. |
vcsGeneratedPaths - [String!]! |
List of paths to mark generated in version control (i.e. .gitattributes). |
vcsIgnoredPaths - [String!]! |
List of paths to ignore in version control (i.e. .gitignore). |
withVCSGeneratedPaths - GeneratedCode! |
Set the list of paths to mark generated in version control. |
Arguments
|
|
withVCSIgnoredPaths - GeneratedCode! |
Set the list of paths to ignore in version control. |
Arguments
|
|
GeneratedCodeID
Description
The GeneratedCodeID scalar type represents an identifier for an object of type GeneratedCode.
GitRef
Description
A git ref (tag, branch, or commit).
GitRefID
Description
The GitRefID scalar type represents an identifier for an object of type GitRef.
GitRepository
Description
A git repository.
Fields
| Field Name | Description |
|---|---|
branch - GitRef! |
Returns details of a branch. |
Arguments
|
|
commit - GitRef! |
Returns details of a commit. |
Arguments
|
|
head - GitRef! |
Returns details for HEAD. |
id - GitRepositoryID! |
A unique identifier for this GitRepository. |
ref - GitRef! |
Returns details of a ref. |
Arguments
|
|
tag - GitRef! |
Returns details of a tag. |
Arguments
|
|
tags - [String!]! |
tags that match any of the given glob patterns. |
Arguments
|
|
withAuthHeader - GitRepository! |
Header to authenticate the remote with. |
Arguments
|
|
withAuthToken - GitRepository! |
Token to authenticate the remote with. |
Arguments
|
|
GitRepositoryID
Description
The GitRepositoryID scalar type represents an identifier for an object of type GitRepository.
Host
Description
Information about the host environment.
Fields
| Field Name | Description |
|---|---|
directory - Directory! |
Accesses a directory on the host. |
file - File! |
Accesses a file on the host. |
Arguments
|
|
id - HostID! |
A unique identifier for this Host. |
service - Service! |
Creates a service that forwards traffic to a specified address via the host. |
Arguments
|
|
setSecretFile - Secret! |
Sets a secret given a user-defined name and the file path on the host, and returns the secret. The file is limited to a size of 512000 bytes. setSecretFile is superceded by use of the secret API with file:// URIs |
tunnel - Service! |
Creates a tunnel that forwards traffic from the host to a service. |
Arguments
|
|
unixSocket - Socket! |
Accesses a Unix socket on the host. |
Arguments
|
|
HostID
Description
The HostID scalar type represents an identifier for an object of type Host.
ImageLayerCompression
Description
Compression algorithm to use for image layers.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Gzip"
ImageMediaTypes
Description
Mediatypes to use in published or exported image metadata.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OCIMediaTypes"
InputTypeDef
Description
A graphql input type, which is essentially just a group of named args. This is currently only used to represent pre-existing usage of graphql input types in the core API. It is not used by user modules and shouldn't ever be as user module accept input objects via their id rather than graphql input types.
Fields
| Field Name | Description |
|---|---|
fields - [FieldTypeDef!]! |
Static fields defined on this input object, if any. |
id - InputTypeDefID! |
A unique identifier for this InputTypeDef. |
name - String! |
The name of the input object. |
InputTypeDefID
Description
The InputTypeDefID scalar type represents an identifier for an object of type InputTypeDef.
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
InterfaceTypeDef
Description
A definition of a custom interface defined in a Module.
Fields
| Field Name | Description |
|---|---|
description - String! |
The doc string for the interface, if any. |
functions - [Function!]! |
Functions defined on this interface, if any. |
id - InterfaceTypeDefID! |
A unique identifier for this InterfaceTypeDef. |
name - String! |
The name of the interface. |
sourceMap - SourceMap! |
The location of this interface declaration. |
sourceModuleName - String! |
If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise. |
InterfaceTypeDefID
Description
The InterfaceTypeDefID scalar type represents an identifier for an object of type InterfaceTypeDef.
JSON
Description
An arbitrary JSON-encoded value.
LLM
Fields
| Field Name | Description |
|---|---|
attempt - LLM! |
create a branch in the LLM's history |
Arguments
|
|
bindResult - Binding |
returns the type of the current state |
Arguments
|
|
env - Env! |
return the LLM's current environment |
history - [String!]! |
return the llm message history |
historyJSON - String! |
return the raw llm message history as json |
id - LLMID! |
A unique identifier for this LLM. |
lastReply - String! |
return the last llm reply from the history |
loop - LLM! |
synchronize LLM state |
model - String! |
return the model used by the llm |
provider - String! |
return the provider used by the llm |
sync - LLMID! |
synchronize LLM state |
tokenUsage - LLMTokenUsage! |
returns the token usage of the current state |
tools - String! |
print documentation for available tools |
withEnv - LLM! |
allow the LLM to interact with an environment via MCP |
Arguments
|
|
withModel - LLM! |
swap out the llm model |
Arguments
|
|
withPrompt - LLM! |
append a prompt to the llm context |
Arguments
|
|
withPromptFile - LLM! |
append the contents of a file to the llm context |
Arguments
|
|
withSystemPrompt - LLM! |
Add a system prompt to the LLM's environment |
Arguments
|
|
LLMID
Description
The LLMID scalar type represents an identifier for an object of type LLM.
LLMTokenUsage
Fields
| Field Name | Description |
|---|---|
id - LLMTokenUsageID! |
A unique identifier for this LLMTokenUsage. |
inputTokens - Int! |
|
outputTokens - Int! |
|
totalTokens - Int! |
LLMTokenUsageID
Description
The LLMTokenUsageID scalar type represents an identifier for an object of type LLMTokenUsage.
Label
LabelID
Description
The LabelID scalar type represents an identifier for an object of type Label.
ListTypeDef
Description
A definition of a list type in a Module.
Fields
| Field Name | Description |
|---|---|
elementTypeDef - TypeDef! |
The type of the elements in the list. |
id - ListTypeDefID! |
A unique identifier for this ListTypeDef. |
ListTypeDefID
Description
The ListTypeDefID scalar type represents an identifier for an object of type ListTypeDef.
Module
Description
A Dagger module.
Fields
| Field Name | Description |
|---|---|
dependencies - [Module!]! |
The dependencies of the module. |
description - String! |
The doc string of the module, if any |
enums - [TypeDef!]! |
Enumerations served by this module. |
generatedContextDirectory - Directory! |
The generated files and directories made on top of the module source's context directory. |
id - ModuleID! |
A unique identifier for this Module. |
interfaces - [TypeDef!]! |
Interfaces served by this module. |
name - String! |
The name of the module |
objects - [TypeDef!]! |
Objects served by this module. |
runtime - Container! |
The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile. |
sdk - SDKConfig |
The SDK config used by this module. |
serve - Void |
Serve a module's API in the current session. Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect. |
source - ModuleSource! |
The source for the module. |
sync - ModuleID! |
Forces evaluation of the module, including any loading into the engine and associated validation. |
withDescription - Module! |
Retrieves the module with the given description |
Arguments
|
|
withEnum - Module! |
This module plus the given Enum type and associated values |
Arguments
|
|
withInterface - Module! |
This module plus the given Interface type and associated functions |
Arguments
|
|
withObject - Module! |
This module plus the given Object type and associated functions. |
Arguments
|
|
ModuleConfigClient
Description
The client generated for the module.
ModuleConfigClientID
Description
The ModuleConfigClientID scalar type represents an identifier for an object of type ModuleConfigClient.
ModuleID
Description
The ModuleID scalar type represents an identifier for an object of type Module.
ModuleSource
Description
The source needed to load and run a module, along with any metadata about the source such as versions/urls/etc.
Fields
| Field Name | Description |
|---|---|
asModule - Module! |
Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation |
asString - String! |
A human readable ref string representation of this module source. |
cloneRef - String! |
The ref to clone the root of the git repo from. Only valid for git sources. |
commit - String! |
The resolved commit of the git repo this source points to. |
configClients - [ModuleConfigClient!]! |
The clients generated for the module. |
configExists - Boolean! |
Whether an existing dagger.json for the module was found. |
contextDirectory - Directory! |
The full directory loaded for the module source, including the source code as a subdirectory. |
dependencies - [ModuleSource!]! |
The dependencies of the module source. |
digest - String! |
A content-hash of the module source. Module sources with the same digest will output the same generated context and convert into the same module instance. |
directory - Directory! |
The directory containing the module configuration and source code (source code may be in a subdir). |
Arguments
|
|
engineVersion - String! |
The engine version of the module. |
generatedContextDirectory - Directory! |
The generated files and directories made on top of the module source's context directory. |
htmlRepoURL - String! |
The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket). |
htmlURL - String! |
The URL to the source's git repo in a web browser. Only valid for git sources. |
id - ModuleSourceID! |
A unique identifier for this ModuleSource. |
kind - ModuleSourceKind! |
The kind of module source (currently local, git or dir). |
localContextDirectoryPath - String! |
The full absolute path to the context directory on the caller's host filesystem that this module source is loaded from. Only valid for local module sources. |
moduleName - String! |
The name of the module, including any setting via the withName API. |
moduleOriginalName - String! |
The original name of the module as read from the module's dagger.json (or set for the first time with the withName API). |
originalSubpath - String! |
The original subpath used when instantiating this module source, relative to the context directory. |
pin - String! |
The pinned version of this module source. |
repoRootPath - String! |
The import path corresponding to the root of the git repo this source points to. Only valid for git sources. |
sdk - SDKConfig |
The SDK configuration of the module. |
sourceRootSubpath - String! |
The path, relative to the context directory, that contains the module's dagger.json. |
sourceSubpath - String! |
The path to the directory containing the module's source code, relative to the context directory. |
sync - ModuleSourceID! |
Forces evaluation of the module source, including any loading into the engine and associated validation. |
version - String! |
The specified version of the git repo this source points to. |
withClient - ModuleSource! |
Update the module source with a new client to generate. |
withDependencies - ModuleSource! |
Append the provided dependencies to the module source's dependency list. |
Arguments
|
|
withEngineVersion - ModuleSource! |
Upgrade the engine version of the module to the given value. |
Arguments
|
|
withIncludes - ModuleSource! |
Update the module source with additional include patterns for files+directories from its context that are required for building it |
Arguments
|
|
withName - ModuleSource! |
Update the module source with a new name. |
Arguments
|
|
withSDK - ModuleSource! |
Update the module source with a new SDK. |
Arguments
|
|
withSourceSubpath - ModuleSource! |
Update the module source with a new source subpath. |
Arguments
|
|
withUpdateDependencies - ModuleSource! |
Update one or more module dependencies. |
Arguments
|
|
withoutDependencies - ModuleSource! |
Remove the provided dependencies from the module source's dependency list. |
Arguments
|
|
ModuleSourceID
Description
The ModuleSourceID scalar type represents an identifier for an object of type ModuleSource.
ModuleSourceKind
Description
The kind of module source.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LOCAL_SOURCE"
NetworkProtocol
Description
Transport layer network protocol associated to a port.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TCP"
ObjectTypeDef
Description
A definition of a custom object defined in a Module.
Fields
| Field Name | Description |
|---|---|
constructor - Function |
The function used to construct new instances of this object, if any |
description - String! |
The doc string for the object, if any. |
fields - [FieldTypeDef!]! |
Static fields defined on this object, if any. |
functions - [Function!]! |
Functions defined on this object, if any. |
id - ObjectTypeDefID! |
A unique identifier for this ObjectTypeDef. |
name - String! |
The name of the object. |
sourceMap - SourceMap! |
The location of this object declaration. |
sourceModuleName - String! |
If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise. |
ObjectTypeDefID
Description
The ObjectTypeDefID scalar type represents an identifier for an object of type ObjectTypeDef.
PipelineLabel
Platform
Description
The platform config OS and architecture in a Container.
The format is [os]/[platform]/[version] (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64").
Port
Description
A port exposed by a container.
Fields
| Field Name | Description |
|---|---|
description - String |
The port description. |
experimentalSkipHealthcheck - Boolean! |
Skip the health check when run as a service. |
id - PortID! |
A unique identifier for this Port. |
port - Int! |
The port number. |
protocol - NetworkProtocol! |
The transport layer protocol. |
PortForward
Description
Port forwarding rules for tunneling network traffic.
Fields
| Input Field | Description |
|---|---|
frontend - Int
|
Port to expose to clients. If unspecified, a default will be chosen. |
backend - Int!
|
Destination port for traffic. |
protocol - NetworkProtocol
|
Transport layer protocol to use for traffic. |
Example
{"frontend": 123, "backend": 123, "protocol": "TCP"}
PortID
Description
The PortID scalar type represents an identifier for an object of type Port.
ReturnType
Description
Expected return type of an execution
Values
| Enum Value | Description |
|---|---|
|
|
A successful execution (exit code 0) |
|
|
A failed execution (exit codes 1-127) |
|
|
Any execution (exit codes 0-127) |
Example
"SUCCESS"
SDKConfig
Description
The SDK config of the module.
Fields
| Field Name | Description |
|---|---|
id - SDKConfigID! |
A unique identifier for this SDKConfig. |
source - String! |
Source of the SDK. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation. |
SDKConfigID
Description
The SDKConfigID scalar type represents an identifier for an object of type SDKConfig.
ScalarTypeDef
Description
A definition of a custom scalar defined in a Module.
Fields
| Field Name | Description |
|---|---|
description - String! |
A doc string for the scalar, if any. |
id - ScalarTypeDefID! |
A unique identifier for this ScalarTypeDef. |
name - String! |
The name of the scalar. |
sourceModuleName - String! |
If this ScalarTypeDef is associated with a Module, the name of the module. Unset otherwise. |
ScalarTypeDefID
Description
The ScalarTypeDefID scalar type represents an identifier for an object of type ScalarTypeDef.
Secret
Description
A reference to a secret value, which can be handled more safely than the value itself.
SecretID
Description
The SecretID scalar type represents an identifier for an object of type Secret.
Service
Description
A content-addressed service providing TCP connectivity.
Fields
| Field Name | Description |
|---|---|
endpoint - String! |
Retrieves an endpoint that clients can use to reach this container. If no port is specified, the first exposed port is used. If none exist an error is returned. If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned. |
hostname - String! |
Retrieves a hostname which can be used by clients to reach this container. |
id - ServiceID! |
A unique identifier for this Service. |
ports - [Port!]! |
Retrieves the list of ports provided by the service. |
start - ServiceID! |
Start the service and wait for its health checks to succeed. Services bound to a Container do not need to be manually started. |
stop - ServiceID! |
Stop the service. |
Arguments
|
|
up - Void |
Creates a tunnel that forwards traffic from the caller's network to this service. |
Arguments
|
|
withHostname - Service! |
Configures a hostname which can be used by clients within the session to reach this container. |
Arguments
|
|
ServiceID
Description
The ServiceID scalar type represents an identifier for an object of type Service.
Socket
SocketID
Description
The SocketID scalar type represents an identifier for an object of type Socket.
SourceMap
Description
Source location information.
Fields
| Field Name | Description |
|---|---|
column - Int! |
The column number within the line. |
filename - String! |
The filename from the module source. |
id - SourceMapID! |
A unique identifier for this SourceMap. |
line - Int! |
The line number within the filename. |
module - String! |
The module dependency this was declared in. |
SourceMapID
Description
The SourceMapID scalar type represents an identifier for an object of type SourceMap.
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Terminal
Description
An interactive terminal that clients can connect to.
Fields
| Field Name | Description |
|---|---|
id - TerminalID! |
A unique identifier for this Terminal. |
sync - TerminalID! |
Forces evaluation of the pipeline in the engine. It doesn't run the default command if no exec has been set. |
TerminalID
Description
The TerminalID scalar type represents an identifier for an object of type Terminal.
TypeDef
Description
A definition of a parameter or return type in a Module.
Fields
| Field Name | Description |
|---|---|
asEnum - EnumTypeDef |
If kind is ENUM, the enum-specific type definition. If kind is not ENUM, this will be null. |
asInput - InputTypeDef |
If kind is INPUT, the input-specific type definition. If kind is not INPUT, this will be null. |
asInterface - InterfaceTypeDef |
If kind is INTERFACE, the interface-specific type definition. If kind is not INTERFACE, this will be null. |
asList - ListTypeDef |
If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null. |
asObject - ObjectTypeDef |
If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null. |
asScalar - ScalarTypeDef |
If kind is SCALAR, the scalar-specific type definition. If kind is not SCALAR, this will be null. |
id - TypeDefID! |
A unique identifier for this TypeDef. |
kind - TypeDefKind! |
The kind of type this is (e.g. primitive, list, object). |
optional - Boolean! |
Whether this type can be set to null. Defaults to false. |
withConstructor - TypeDef! |
Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object. |
Arguments
|
|
withEnum - TypeDef! |
Returns a TypeDef of kind Enum with the provided name. Note that an enum's values may be omitted if the intent is only to refer to an enum. This is how functions are able to return their own, or any other circular reference. |
Arguments
|
|
withEnumValue - TypeDef! |
Adds a static value for an Enum TypeDef, failing if the type is not an enum. |
Arguments
|
|
withField - TypeDef! |
Adds a static field for an Object TypeDef, failing if the type is not an object. |
Arguments
|
|
withFunction - TypeDef! |
Adds a function for an Object or Interface TypeDef, failing if the type is not one of those kinds. |
Arguments
|
|
withInterface - TypeDef! |
Returns a TypeDef of kind Interface with the provided name. |
Arguments |
|
withKind - TypeDef! |
Sets the kind of the type. |
Arguments
|
|
withListOf - TypeDef! |
Returns a TypeDef of kind List with the provided type for its elements. |
Arguments
|
|
withObject - TypeDef! |
Returns a TypeDef of kind Object with the provided name. Note that an object's fields and functions may be omitted if the intent is only to refer to an object. This is how functions are able to return their own object, or any other circular reference. |
Arguments |
|
withOptional - TypeDef! |
Sets whether this type can be set to null. |
Arguments
|
|
withScalar - TypeDef! |
Returns a TypeDef of kind Scalar with the provided name. |
TypeDefID
Description
The TypeDefID scalar type represents an identifier for an object of type TypeDef.
TypeDefKind
Description
Distinguishes the different kinds of TypeDefs.
Values
| Enum Value | Description |
|---|---|
|
|
A string value. |
|
|
A float value. |
|
|
An integer value. |
|
|
A boolean value. |
|
|
A scalar value of any basic kind. |
|
|
A list of values all having the same type. Always paired with a ListTypeDef. |
|
|
A named type defined in the GraphQL schema, with fields and functions. Always paired with an ObjectTypeDef. |
|
|
A named type of functions that can be matched+implemented by other objects+interfaces. Always paired with an InterfaceTypeDef. |
|
|
A graphql input type, used only when representing the core API via TypeDefs. |
|
|
A special kind used to signify that no value is returned. This is used for functions that have no return value. The outer TypeDef specifying this Kind is always Optional, as the Void is never actually represented. |
|
|
A GraphQL enum type and its values Always paired with an EnumTypeDef. |
Example
"STRING_KIND"
Void
Description
The absence of a value.
A Null Void is used as a placeholder for resolvers that do not return anything.