Skip to content
Drydock
API

App API

Application info, server configuration, and diagnostic endpoints.

Get App information

Returns the application name, version and build.

curl http://drydock:3000/api/v1/app

{
  "name":"drydock",
  "version":"1.9.0",
  "build":"1.9.0-rc.1"
}
FieldTypeDescription
namestringAlways drydock
versionstringBase version, with any prerelease suffix removed. This is the version the UI shows
buildstringFull build identity. Same as version unless the image was built as a prerelease

Version and build

A stable release is the last release candidate's image, promoted unchanged. Nothing is rebuilt, so the image you pull as 1.6.1 is the same image as 1.6.1-rc.15, and it can't tell which tag it was pulled by. It reports "version":"1.6.1" and "build":"1.6.1-rc.15".

So a release candidate in build on a stable tag is expected. It names the candidate the release was promoted from, and it doesn't mean you're running a prerelease. Include the build when you report a bug.

A build with no prerelease suffix, or a custom value such as local, reports the same string in both fields. Drydock versions that predate build reported the full build identity as version and had no build field.

Get server configuration

Returns the server configuration, webhook status, and legacy input compatibility summary.

curl http://drydock:3000/api/v1/server

{
  "configuration": {
    "port": 3000,
    "feature": { "delete": false },
    "webhook": { "enabled": true }
  },
  "compatibility": {
    "legacyInputs": {}
  }
}

Get security runtime status

Returns backend, provider, scanner-asset, Cosign, and SBOM-generator status. Providers that run as local commands are checked as binaries; providers that run in workers (auto without a resolvable binary, docker, remote) are checked as digest-pinned worker assets.

curl http://drydock:3000/api/v1/server/security/runtime

{
  "checkedAt": "2026-03-18T19:33:00.000Z",
  "ready": true,
  "backend": "auto",
  "availabilityPolicy": "block",
  "gate": { "mode": "on", "allowNoWorse": true },
  "scanner": {
    "enabled": true,
    "command": "ghcr.io/anchore/grype:v0.121.0@sha256:…",
    "commandAvailable": true,
    "status": "ready",
    "message": "grype scanner is ready via docker",
    "scanner": "grype",
    "server": ""
  },
  "signature": {
    "enabled": false,
    "command": "",
    "commandAvailable": null,
    "status": "disabled",
    "message": "Signature verification is disabled"
  },
  "sbom": {
    "enabled": true,
    "formats": ["spdx-json", "cyclonedx-json"],
    "generator": "syft"
  },
  "providers": [{ "provider": "grype", "role": "scanner", "status": "ready" }],
  "assets": [{ "provider": "grype", "state": "ready", "resolvedDigest": "sha256:…" }],
  "requirements": []
}

Response fields

FieldTypeDescription
checkedAtstringISO 8601 timestamp of the check
readybooleantrue when every required scanner/SBOM provider is ready
backendstringConfigured backend: auto (default), command, docker, or Trivy-only remote
availabilityPolicystringFail-closed block or explicit advisory warn
gate.modestringEffective global gate mode: on or off
gate.allowNoWorsebooleanWhether blocked candidates can pass a fail-closed severity-by-severity comparison with the current image scan
scanner.enabledbooleanWhether vulnerability scanning is configured
scanner.commandstringScanner command, or the worker image when the scanner runs in a worker
scanner.commandAvailableboolean | nullWhether the command was found in the runtime; null when disabled
scanner.statusstringready, missing, or disabled
scanner.serverstringTrivy server URL (empty when using local mode)
signature.enabledbooleanWhether signature verification is configured
signature.commandstringCosign command, or the worker image when cosign runs in a worker
signature.commandAvailableboolean | nullWhether cosign (or its worker image) is ready
signature.statusstringready, missing, or disabled
sbom.enabledbooleanWhether SBOM generation is enabled
sbom.formatsstring[]Configured SBOM output formats
sbom.generatorstringEffective trivy or syft generator
providersobject[]Normalized provider health and remediation details
assetsobject[]Worker image state, configured/resolved digest, version, cache timestamps, and failures
requirementsstring[]Human-readable list of missing dependencies (empty when everything is ready)

Returns 200 on success, or 500 if the runtime check fails.

Pull or warm scanner assets

Providers that run in workers expose an audited lifecycle action:

curl -X POST http://drydock:3000/api/v1/server/security/assets/grype/pull
curl -X POST http://drydock:3000/api/v1/server/security/assets/grype/warm

Providers are trivy, grype, syft, and cosign; operations are pull and warm. The response is the resulting asset status. Invalid combinations return 400, while runtime/pull/warm failures return 503 without exposing credentials.

Download diagnostic debug dump

Downloads a comprehensive, redacted diagnostic dump of the running drydock instance as a JSON file. Useful for troubleshooting and support requests.

The dump includes runtime metadata, component state (watchers, registries, triggers, agents, containers), Docker API diagnostics, MQTT Home Assistant sensor definitions, recent Docker events, store statistics, and DD_* environment variable names. In v1.9.0-rc.1 builds, store statistics report SQLite table row counts under the compatibility field collections (each entry has name and documents). The aggregate serializedBytes is SQLite's page_count multiplied by page_size, not JSON serialization size or per-table byte attribution. Internal migration and store-metadata tables are excluded from the row counts; raw stored rows are not included.

Redaction works on the key name, and the exact rule matters — a key that falls outside it is returned verbatim:

  • A value is redacted when its key contains password, passwd, secret, token, credential, hash, apikey, accesskey, privatekey, clientkey, or signingkey, ignoring case and word separators. This is what covers compound names such as CLIENTSECRET, BOTTOKEN and SECRETACCESSKEY.
  • pass, key and pat only match a whole word segment, so COMPASS_MODE, KEYFILE and DISPATCH stay visible.
  • Environment-style keys (uppercase with underscores) additionally redact on the segments AUTH, BEARER, LOGIN and URL, which covers webhook URLs with an embedded secret. DD_PUBLIC_URL is redacted along with them, deliberately.
  • Any string value carrying URL credentials (postgres://user:pass@host) is redacted whatever its key is called.
  • A few provider-specific fields are redacted by name even though they don't match any of the rules above: Apprise URLS, Pushover USER, Rocket.Chat USER_ID, and Telegram CHATID.
  • Container runtime environment variables come from the same redactor GET /containers uses, so the dump is never a laxer view of them than the API is.

Names are always kept; only values are replaced with [REDACTED]. Downloads are recorded in the audit log as debug-dump and the route is limited to 5 requests per minute.

curl -O -J "http://drydock:3000/api/v1/debug/dump?minutes=30"

The response is a JSON attachment with a timestamped filename (e.g. drydock-debug-dump-2026-03-18T19-33-00-000Z.json).

Query parameters

ParameterTypeDefaultDescription
minutesinteger30How many recent minutes of event history to include (min: 1)

Dump sections

SectionContents
metadataGenerated timestamp, drydock version (drydockVersion) and build (drydockBuild), Node.js version, uptime
stateAll registered components: containers, watchers, triggers, registries, authentications, agents
mqttHomeAssistantHome Assistant MQTT sensor discovery topics and definitions
dockerEventsActive Docker event subscriptions and recent events within the time window
aliasFilteringRecent container alias filter decisions
storeSQLite table row counts, aggregate database page size as serializedBytes, and store paths; no per-table byte attribution
dockerApiDocker daemon version and info per watcher (connection errors captured gracefully)
environmentAll DD_* environment variable names, with values redacted by the rules above

Returns 200 with the JSON attachment on success, 401 if not authenticated, 429 if more than 5 dumps are requested in a minute, or 500 if the dump cannot be generated.