{"id":48363,"date":"2025-02-08T08:13:21","date_gmt":"2025-02-08T08:13:21","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=48363"},"modified":"2025-07-12T05:38:46","modified_gmt":"2025-07-12T05:38:46","slug":"docker-inspect","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/docker-inspect\/","title":{"rendered":"Docker commands Guide – docker inspect with examples"},"content":{"rendered":"\n

Here\u2019s a complete tutorial<\/strong> on docker inspect<\/code>, including its purpose<\/strong>, how it works<\/strong>, and a comprehensive list of examples<\/strong>.<\/p>\n\n\n\n

\n\n\n\n

What is docker inspect<\/code>?<\/strong><\/h2>\n\n\n\n

docker inspect<\/code> is a Docker command used to retrieve detailed information<\/strong> about containers, images, networks, and volumes<\/strong> in JSON format. It provides extensive data such as configuration, networking, mounts, process details, and more.<\/p>\n\n\n\n

Key Features:<\/strong><\/p>\n\n\n\n

    \n
  • Works with containers, images, networks, and volumes<\/strong>.<\/li>\n\n\n\n
  • Returns data in JSON format<\/strong>.<\/li>\n\n\n\n
  • Ideal for debugging, auditing, and scripting<\/strong>.<\/li>\n\n\n\n
  • Supports filtering specific data with --format<\/code><\/strong>.<\/li>\n<\/ul>\n\n\n\n
    \n\n\n\n

    Basic Syntax<\/strong><\/h2>\n\n\n
    docker inspect [OPTIONS] NAME|ID [NAME|ID...]\n<\/code><\/span><\/pre>\n\n\n
    Options:<\/strong><\/h3>\n\n\n\n
      \n
    • --format<\/code>: Format the output using a Go template<\/strong>.<\/li>\n\n\n\n
    • --type<\/code>: Specify the type of object (container<\/code>, image<\/code>, network<\/code>, or volume<\/code>).<\/li>\n<\/ul>\n\n\n\n
      \n\n\n\n
      Examples of docker inspect<\/code><\/strong><\/h2>\n\n\n\n
      1. Inspect a Running Container<\/strong><\/h3>\n\n\n
      docker inspect my_container\n<\/code><\/span><\/pre>\n\n\n
      This returns the full JSON output containing all details about my_container<\/code>.<\/p>\n\n\n\n
      \n\n\n\n
      2. Inspect a Docker Image<\/strong><\/h3>\n\n\n
      docker inspect ubuntu\n<\/code><\/span><\/pre>\n\n\n
      This command retrieves metadata for the ubuntu<\/code> image, including its ID, creation date, layers, and configuration.<\/p>\n\n\n\n
      \n\n\n\n
      3. Inspect a Network<\/strong><\/h3>\n\n\n
      docker inspect my_network\n<\/code><\/span><\/pre>\n\n\n
      This shows details of the my_network<\/code> Docker network, such as the driver type (bridge, overlay), subnet, and connected containers.<\/p>\n\n\n\n
      \n\n\n\n
      4. Inspect a Volume<\/strong><\/h3>\n\n\n
      docker inspect my_volume\n<\/code><\/span><\/pre>\n\n\n
      This retrieves information about the my_volume<\/code> volume, including its mount path and creation time.<\/p>\n\n\n\n
      \n\n\n\n
      Using --format<\/code> to Filter Specific Information<\/strong><\/h2>\n\n\n\n
      The full JSON output can be overwhelming. Use the --format<\/code> option to extract specific data using Go templates.<\/p>\n\n\n\n
      5. Get a Container\u2019s IP Address<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .NetworkSettings.IPAddress }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This returns only the IP address of my_container<\/code>.<\/p>\n\n\n\n
      \n\n\n\n
      6. Get a Container\u2019s Mounts<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ json .Mounts }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This returns details about the container\u2019s mounted volumes in JSON format.<\/p>\n\n\n\n
      \n\n\n\n
      7. Get the Container\u2019s Image Name<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .Config.Image }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      8. Get the Image ID of an Image<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .Id }}'<\/span> ubuntu\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This returns the unique ID of the ubuntu<\/code> image.<\/p>\n\n\n\n
      \n\n\n\n
      9. Get a Container\u2019s Environment Variables<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .Config.Env }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This returns all environment variables set in my_container<\/code>.<\/p>\n\n\n\n
      \n\n\n\n
      10. Check the Restart Policy of a Container<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .HostConfig.RestartPolicy.Name }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      11. Get the Labels of a Container<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .Config.Labels }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This returns any labels associated with the container.<\/p>\n\n\n\n
      \n\n\n\n
      12. Check the Container\u2019s State (Running, Stopped, or Paused)<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .State.Status }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This shows whether the container is running<\/code>, exited<\/code>, or paused<\/code>.<\/p>\n\n\n\n
      \n\n\n\n
      13. Inspect Multiple Containers at Once<\/strong><\/h3>\n\n\n
      docker inspect my_container1 my_container2\n<\/code><\/span><\/pre>\n\n\n
      This displays detailed information about both containers.<\/p>\n\n\n\n
      \n\n\n\n
      14. Get the Path to the Container\u2019s Log File<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .LogPath }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      15. Get Network Information (IP, Gateway, and Subnet)<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .NetworkSettings.Networks.bridge.IPAddress }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      This command extracts the IP address from the bridge<\/code> network.<\/p>\n\n\n\n
      \n\n\n\n
      Examples of Inspecting Specific Object Types (--type<\/code>)<\/strong><\/h2>\n\n\n\n
      16. Inspect Only Containers<\/strong><\/h3>\n\n\n
      docker inspect --type container my_container\n<\/code><\/span><\/pre>\n\n\n
      17. Inspect Only Networks<\/strong><\/h3>\n\n\n
      docker inspect --type network my_network\n<\/code><\/span><\/pre>\n\n\n
      18. Inspect Only Images<\/strong><\/h3>\n\n\n
      docker inspect --type image ubuntu\n<\/code><\/span><\/pre>\n\n\n
      \n\n\n\n
      Combining docker inspect<\/code> with Other Commands<\/strong><\/h2>\n\n\n\n
      19. Check if a Container is Running Before Stopping It<\/strong><\/h3>\n\n\n
      if<\/span> [ \"$(docker inspect --format='{{ .State.Running }}' my_container)\"<\/span> == \"true\"<\/span> ]<\/span>; then<\/span>\n  docker<\/span> stop<\/span> my_container<\/span>\nfi<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
      20. Monitor a Container\u2019s CPU Usage<\/strong><\/h3>\n\n\n
      docker inspect --format='{{ .HostConfig.CpuShares }}'<\/span> my_container\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \n\n\n\n
      List of Common docker inspect<\/code> Commands<\/strong><\/h2>\n\n\n\n
      Command<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
      docker inspect my_container<\/code><\/td>Inspect a running container<\/td><\/tr>
      docker inspect ubuntu<\/code><\/td>Inspect a Docker image<\/td><\/tr>
      docker inspect my_network<\/code><\/td>Inspect a Docker network<\/td><\/tr>
      docker inspect my_volume<\/code><\/td>Inspect a Docker volume<\/td><\/tr>
      docker inspect --format='{{ .Config.Env }}'<\/code><\/td>Get environment variables from a container<\/td><\/tr>
      docker inspect --format='{{ .State.Status }}'<\/code><\/td>Check if a container is running, exited, or paused<\/td><\/tr>
      docker inspect --type network<\/code><\/td>Inspect networks only<\/td><\/tr>
      docker inspect --type image<\/code><\/td>Inspect images only<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n
      Best Practices for Using docker inspect<\/code>:<\/strong><\/h2>\n\n\n\n
        \n
      1. Use --format<\/code> to filter<\/strong> and avoid scrolling through long JSON output.<\/li>\n\n\n\n
      2. Automate monitoring scripts<\/strong> using filtered docker inspect<\/code> data.<\/li>\n\n\n\n
      3. Inspect logs and network settings<\/strong> for debugging.<\/li>\n\n\n\n
      4. Combine with other Docker commands<\/strong> for advanced workflows.<\/li>\n<\/ol>\n\n\n\n
        \n\n\n\n
        Common Errors and Solutions<\/strong><\/h2>\n\n\n\n
          \n
        1. “No such object: “<\/strong>
          \u2192 Ensure the container, image, or network exists. Check with docker ps<\/code>, docker images<\/code>, or docker network ls<\/code>.<\/li>\n\n\n\n
        2. Incorrect JSON Path with --format<\/code><\/strong>
          \u2192 Verify the JSON structure using the full docker inspect<\/code> output before creating a custom filter.<\/li>\n<\/ol>\n\n\n\n
          \n\n\n\n
          <\/p>\n","protected":false},"excerpt":{"rendered":"
          Here\u2019s a complete tutorial on docker inspect, including its purpose, how it works, and a comprehensive list of examples. What is docker inspect? docker inspect is a Docker command used… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[4862],"tags":[],"class_list":["post-48363","post","type-post","status-publish","format-standard","hentry","category-docker"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/48363","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=48363"}],"version-history":[{"count":2,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/48363\/revisions"}],"predecessor-version":[{"id":48365,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/48363\/revisions\/48365"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=48363"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=48363"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=48363"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}