Search or ask Docker

ConfigSpec

ConfigSpec schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Data

Type: string

Data is the data to store as a config, formatted as a standard base64-encoded (RFC 4648) string. The maximum allowed size is 1000KB, as defined in MaxConfigSize.
All schema constraints and annotations
{
  "description": "Data is the data to store as a config, formatted as a standard base64-encoded\n([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string.\nThe maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize).\n",
  "type": "string"
}
Labels

Type: object

User-defined key/value metadata.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "User-defined key/value metadata.",
  "type": "object"
}
Name

Type: string

User-defined name of the config.
All schema constraints and annotations
{
  "description": "User-defined name of the config.",
  "type": "string"
}
Templating

Schema: Driver

Templating driver, if applicable

Templating controls whether and how to evaluate the config payload as a template. If no driver is set, no templating is used.

All schema constraints and annotations
{
  "$ref": "#/components/schemas/Driver",
  "description": "Templating driver, if applicable\n\nTemplating controls whether and how to evaluate the config payload as\na template. If no driver is set, no templating is used.\n"
}
All schema constraints and annotations
{
  "properties": {
    "Data": {
      "description": "Data is the data to store as a config, formatted as a standard base64-encoded\n([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string.\nThe maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize).\n",
      "type": "string"
    },
    "Labels": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "User-defined key/value metadata.",
      "type": "object"
    },
    "Name": {
      "description": "User-defined name of the config.",
      "type": "string"
    },
    "Templating": {
      "$ref": "#/components/schemas/Driver",
      "description": "Templating driver, if applicable\n\nTemplating controls whether and how to evaluate the config payload as\na template. If no driver is set, no templating is used.\n"
    }
  },
  "type": "object"
}