Docker Engine API
  1. Service
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
    • Create a config
    • Delete a config
    • Inspect a config
    • Update a Config
  • 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
      GET
    • Create a service
      POST
    • Delete a service
      DELETE
    • Inspect a service
      GET
    • Get service logs
      GET
    • Update a service
      POST
  • 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. Service

Inspect a service

/v1.33
/v1.33
/v1.33
/v1.33
GET
/services/{id}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/services/'
Response Response Example
200 - Example 1
{
    "CreatedAt": "2016-06-07T21:05:51.880065305Z",
    "Endpoint": {
        "Ports": [
            {
                "Protocol": "tcp",
                "PublishedPort": 30001,
                "TargetPort": 6379
            }
        ],
        "Spec": {
            "Mode": "vip",
            "Ports": [
                {
                    "Protocol": "tcp",
                    "PublishedPort": 30001,
                    "TargetPort": 6379
                }
            ]
        },
        "VirtualIPs": [
            {
                "Addr": "10.255.0.2/16",
                "NetworkID": "4qvuz4ko70xaltuqbt8956gd1"
            },
            {
                "Addr": "10.255.0.3/16",
                "NetworkID": "4qvuz4ko70xaltuqbt8956gd1"
            }
        ]
    },
    "ID": "9mnpnzenvg8p8tdbtq4wvbkcz",
    "Spec": {
        "EndpointSpec": {
            "Mode": "vip",
            "Ports": [
                {
                    "Protocol": "tcp",
                    "PublishedPort": 30001,
                    "TargetPort": 6379
                }
            ]
        },
        "Mode": {
            "Replicated": {
                "Replicas": 1
            }
        },
        "Name": "hopeful_cori",
        "RollbackConfig": {
            "Delay": 1000000000,
            "FailureAction": "pause",
            "MaxFailureRatio": 0.15,
            "Monitor": 15000000000,
            "Parallelism": 1
        },
        "TaskTemplate": {
            "ContainerSpec": {
                "Image": "redis"
            },
            "ForceUpdate": 0,
            "Placement": {},
            "Resources": {
                "Limits": {},
                "Reservations": {}
            },
            "RestartPolicy": {
                "Condition": "any",
                "MaxAttempts": 0
            }
        },
        "UpdateConfig": {
            "Delay": 1000000000,
            "FailureAction": "pause",
            "MaxFailureRatio": 0.15,
            "Monitor": 15000000000,
            "Parallelism": 1
        }
    },
    "UpdatedAt": "2016-06-07T21:07:29.962229872Z",
    "Version": {
        "Index": 19
    }
}

Request

Path Params

Query Params

Responses

🟢200no error
application/json
Body

🟠404no such service
🔴500server error
🔴503node is not part of a swarm
Modified at 2022-09-10 17:56:07
Previous
Delete a service
Next
Get service logs
Built with