Docker Engine API
  1. Config
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
      POST
    • Delete builder cache
      POST
    • Create a new image from a container
      POST
    • Create an image
      POST
    • Export several images
      GET
    • List Images
      GET
    • Import images
      POST
    • Delete unused images
      POST
    • Search images
      GET
    • Remove an image
      DELETE
    • Export an image
      GET
    • Get the history of an image
      GET
    • Inspect an image
      GET
    • Push an image
      POST
    • Tag an image
      POST
  • Config
    • List configs
      GET
    • Create a config
      POST
    • Delete a config
      DELETE
    • Inspect a config
      GET
    • Update a Config
      POST
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  1. Config

Inspect a config

/v1.33
/v1.33
/v1.33
/v1.33
GET
/configs/{id}
Config
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/configs/'
Response Response Example
200 - response
{
    "CreatedAt": "2016-11-05T01:20:17.327670065Z",
    "ID": "ktnbjxoalbkvbvedmg1urrz8h",
    "Spec": {
        "Name": "app-dev.crt"
    },
    "UpdatedAt": "2016-11-05T01:20:17.327670065Z",
    "Version": {
        "Index": 11
    }
}

Request

Path Params
id
string 
required
ID of the config

Responses

🟢200no error
application/json
Body
CreatedAt
string <dateTime>
optional
ID
string 
optional
Spec
object (ConfigSpec) 
optional
Data
string 
optional
Base64-url-safe-encoded (RFC 4648)
config data.
Labels
object 
optional
User-defined key/value metadata.
Name
string 
optional
User-defined name of the config.
UpdatedAt
string <dateTime>
optional
Version
object (ObjectVersion) 
optional
The version number of the object such as node, service, etc. This is needed to avoid conflicting writes.
The client must send the version number along with the modified specification when updating these objects.
This approach ensures safe concurrency and determinism in that the change on the object
may not be applied if the version number has changed from the last read. In other words,
if two update requests specify the same base version, only one of the requests can succeed.
As a result, two separate update requests that happen at the same time will not
unintentionally overwrite each other.
Index
integer <uint64>
optional
Example:
373531
🟠404config not found
🔴500server error
🔴503node is not part of a swarm
Modified at 2022-09-10 17:56:06
Previous
Delete a config
Next
Update a Config
Built with