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

Update a service

/v1.33
/v1.33
/v1.33
/v1.33
POST
/services/{id}/update
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1.33/services//update?version=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "EndpointSpec": {
        "Mode": "vip",
        "Ports": [
            {
                "Name": "string",
                "Protocol": "tcp",
                "PublishedPort": 0,
                "TargetPort": 0
            }
        ]
    },
    "Labels": {
        "property1": "string",
        "property2": "string"
    },
    "Mode": {
        "Global": {},
        "Replicated": {
            "Replicas": 1
        }
    },
    "Name": "top",
    "Networks": [
        {
            "Aliases": [
                "string"
            ],
            "Target": "string"
        }
    ],
    "RollbackConfig": {
        "Delay": 1000000000,
        "FailureAction": "pause",
        "MaxFailureRatio": 0.15,
        "Monitor": 15000000000,
        "Order": "stop-first",
        "Parallelism": 1
    },
    "TaskTemplate": {
        "ContainerSpec": {
            "Args": [
                "top"
            ],
            "Command": [
                "string"
            ],
            "Configs": [
                {
                    "ConfigID": "string",
                    "ConfigName": "string",
                    "File": {
                        "GID": "string",
                        "Mode": 0,
                        "Name": "string",
                        "UID": "string"
                    }
                }
            ],
            "DNSConfig": {
                "Nameservers": [
                    "string"
                ],
                "Options": [
                    "string"
                ],
                "Search": [
                    "string"
                ]
            },
            "Dir": "string",
            "Env": [
                "string"
            ],
            "Groups": [
                "string"
            ],
            "HealthCheck": {
                "Interval": 0,
                "Retries": 0,
                "StartPeriod": 0,
                "Test": [
                    "string"
                ],
                "Timeout": 0
            },
            "Hostname": "string",
            "Hosts": [
                "string"
            ],
            "Image": "busybox",
            "Labels": {
                "property1": "string",
                "property2": "string"
            },
            "Mounts": [
                {
                    "BindOptions": {
                        "Propagation": "private"
                    },
                    "Consistency": "string",
                    "ReadOnly": true,
                    "Source": "string",
                    "Target": "string",
                    "TmpfsOptions": {
                        "Mode": 0,
                        "SizeBytes": 0
                    },
                    "Type": "bind",
                    "VolumeOptions": {
                        "DriverConfig": {
                            "Name": "string",
                            "Options": {
                                "property1": "string",
                                "property2": "string"
                            }
                        },
                        "Labels": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "NoCopy": false
                    }
                }
            ],
            "OpenStdin": true,
            "Privileges": {
                "CredentialSpec": {
                    "File": "string",
                    "Registry": "string"
                },
                "SELinuxContext": {
                    "Disable": true,
                    "Level": "string",
                    "Role": "string",
                    "Type": "string",
                    "User": "string"
                }
            },
            "ReadOnly": true,
            "Secrets": [
                {
                    "File": {
                        "GID": "string",
                        "Mode": 0,
                        "Name": "string",
                        "UID": "string"
                    },
                    "SecretID": "string",
                    "SecretName": "string"
                }
            ],
            "StopGracePeriod": 0,
            "StopSignal": "string",
            "TTY": true,
            "User": "string"
        },
        "ForceUpdate": 0,
        "LogDriver": {
            "Name": "string",
            "Options": {
                "property1": "string",
                "property2": "string"
            }
        },
        "Networks": [
            {
                "Aliases": [
                    "string"
                ],
                "Target": "string"
            }
        ],
        "Placement": {
            "Constraints": [
                "node.hostname!=node3.corp.example.com",
                "node.role!=manager",
                "node.labels.type==production"
            ],
            "Platforms": [
                {
                    "Architecture": "x86_64",
                    "OS": "linux"
                }
            ],
            "Preferences": [
                {
                    "Spread": {
                        "SpreadDescriptor": "node.labels.datacenter"
                    }
                },
                {
                    "Spread": {
                        "SpreadDescriptor": "node.labels.rack"
                    }
                }
            ]
        },
        "PluginSpec": {
            "Disabled": true,
            "Name": "string",
            "PluginPrivilege": [
                {
                    "Description": "string",
                    "Name": "string",
                    "Value": [
                        "string"
                    ]
                }
            ],
            "Remote": "string"
        },
        "Resources": {
            "Limits": {
                "GenericResources": [
                    {
                        "DiscreteResourceSpec": {
                            "Kind": "SSD",
                            "Value": 3
                        }
                    },
                    {
                        "NamedResourceSpec": {
                            "Kind": "GPU",
                            "Value": "UUID1"
                        }
                    },
                    {
                        "NamedResourceSpec": {
                            "Kind": "GPU",
                            "Value": "UUID2"
                        }
                    }
                ],
                "MemoryBytes": 8272408576,
                "NanoCPUs": 4000000000
            },
            "Reservation": {
                "GenericResources": [
                    {
                        "DiscreteResourceSpec": {
                            "Kind": "SSD",
                            "Value": 3
                        }
                    },
                    {
                        "NamedResourceSpec": {
                            "Kind": "GPU",
                            "Value": "UUID1"
                        }
                    },
                    {
                        "NamedResourceSpec": {
                            "Kind": "GPU",
                            "Value": "UUID2"
                        }
                    }
                ],
                "MemoryBytes": 8272408576,
                "NanoCPUs": 4000000000
            },
            "Reservations": {}
        },
        "RestartPolicy": {
            "Condition": "any",
            "Delay": 0,
            "MaxAttempts": 0,
            "Window": 0
        },
        "Runtime": "string"
    },
    "UpdateConfig": {
        "Delay": 1000000000,
        "FailureAction": "pause",
        "MaxFailureRatio": 0.15,
        "Monitor": 15000000000,
        "Order": "stop-first",
        "Parallelism": 2
    }
}'
Response Response Example
200 - Example 1
{
    "Warning": "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
}

Request

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200no error
application/json
Body

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