Query parameters

• filters string

  A JSON encoded value of the filters (a map[string][]string) to process on the tasks list.

  Available filters:

  • desired-state=(running | shutdown | accepted)
  • id=<task id>
  • label=key or label="key=value"
  • name=<task name>
  • node=<node id or name>
  • service=<service name>

Responses

• 200 application/json

  no error

  Hide response attributes Show response attributes object

  • ID string

    The ID of the task.

  • Version object

    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.

    Hide Version attribute Show Version attribute object

    • Index integer(uint64)
  • CreatedAt string(dateTime)
  • UpdatedAt string(dateTime)
  • Name string

    Name of the task.

  • Labels object

    User-defined key/value metadata.

    Hide Labels attribute Show Labels attribute object

    • * string Additional properties
  • Spec object

    User modifiable task configuration.

    Hide Spec attributes Show Spec attributes object

    • PluginSpec object

      Plugin spec for the service. (Experimental release only.)

      
      

      Note: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are mutually exclusive. PluginSpec is only used when the Runtime field is set to plugin. NetworkAttachmentSpec is used when the Runtime field is set to attachment.

      Hide PluginSpec attributes Show PluginSpec attributes object

      • Name string

        The name or 'alias' to use for the plugin.

      • Remote string

        The plugin image reference to use.

      • Disabled boolean

        Disable the plugin once scheduled.

      • PluginPrivilege array[object]

        Describes a permission the user has to accept upon installing the plugin.

        Hide PluginPrivilege attributes Show PluginPrivilege attributes object

        • Name string
        • Description string
        • Value array[string]
    • ContainerSpec object

      Container spec for the service.

      
      

      Note: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are mutually exclusive. PluginSpec is only used when the Runtime field is set to plugin. NetworkAttachmentSpec is used when the Runtime field is set to attachment.

      Hide ContainerSpec attributes Show ContainerSpec attributes object

      • Image string

        The image name to use for the container

      • Labels object

        User-defined key/value data.

        Hide Labels attribute Show Labels attribute object

        • * string Additional properties
      • Command array[string]

        The command to be run in the image.

      • Args array[string]

        Arguments to the command.

      • Hostname string

        The hostname to use for the container, as a valid RFC 1123 hostname.

      • Env array[string]

        A list of environment variables in the form VAR=value.

      • Dir string

        The working directory for commands to run in.

      • User string

        The user inside the container.

      • Groups array[string]

        A list of additional groups that the container process will run as.

      • Privileges object

        Security options for the container

        Hide Privileges attributes Show Privileges attributes object

        • CredentialSpec object

          CredentialSpec for managed service account (Windows only)

          Hide CredentialSpec attributes Show CredentialSpec attributes object

          • Config string

            Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set.

            
            

            Note: CredentialSpec.File, CredentialSpec.Registry, and CredentialSpec.Config are mutually exclusive.

          • File string

            Load credential spec from this file. The file is read by the daemon, and must be present in the CredentialSpecs subdirectory in the docker data directory, which defaults to C:\ProgramData\Docker\ on Windows.

            For example, specifying spec.json loads C:\ProgramData\Docker\CredentialSpecs\spec.json.

            
            

            Note: CredentialSpec.File, CredentialSpec.Registry, and CredentialSpec.Config are mutually exclusive.

          • Registry string

            Load credential spec from this value in the Windows registry. The specified registry value must be located in:

            HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs

            
            

            Note: CredentialSpec.File, CredentialSpec.Registry, and CredentialSpec.Config are mutually exclusive.

        • SELinuxContext object

          SELinux labels of the container

          Hide SELinuxContext attributes Show SELinuxContext attributes object

          • Disable boolean

            Disable SELinux

          • User string

            SELinux user label

          • Role string

            SELinux role label

          • Type string

            SELinux type label

          • Level string

            SELinux level label

        • Seccomp object

          Options for configuring seccomp on the container

          Hide Seccomp attributes Show Seccomp attributes object

          • Mode string

            Values are default, unconfined, or custom.

          • Profile string

            The custom seccomp profile as a json object

        • AppArmor object

          Options for configuring AppArmor on the container

          Hide AppArmor attribute Show AppArmor attribute object

          • Mode string

            Values are default or disabled.

        • NoNewPrivileges boolean

          Configuration of the no_new_privs bit in the container

      • TTY boolean

        Whether a pseudo-TTY should be allocated.

      • OpenStdin boolean

        Open stdin

      • ReadOnly boolean

        Mount the container's root filesystem as read only.

      • Mounts array[object]

        Specification for mounts to be added to containers created as part of the service.

        Hide Mounts attributes Show Mounts attributes object

        • Target string

          Container path.

        • Source string

          Mount source (e.g. a volume name, a host path).

        • Type string

          The mount type. Available types:

          • bind Mounts a file or directory from the host into the container. Must exist prior to creating the container.
          • volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed.
          • image Mounts an image.
          • tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
          • npipe Mounts a named pipe from the host into the container. Must exist prior to creating the container.
          • cluster a Swarm cluster volume

          Values are bind, volume, image, tmpfs, npipe, or cluster.

        • ReadOnly boolean

          Whether the mount should be read-only.

        • Consistency string

          The consistency requirement for the mount: default, consistent, cached, or delegated.

        • BindOptions object

          Optional configuration for the bind type.

          Hide BindOptions attributes Show BindOptions attributes object

          • Propagation string

            A propagation mode with the value [r]private, [r]shared, or [r]slave.

            Values are private, rprivate, shared, rshared, slave, or rslave.

          • NonRecursive boolean

            Disable recursive bind mount.

            Default value is false.

          • CreateMountpoint boolean

            Create mount point on host if missing

            Default value is false.

          • ReadOnlyNonRecursive boolean

            Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction).

            Added in v1.44, before that version all read-only mounts were non-recursive by default. To match the previous behaviour this will default to true for clients on versions prior to v1.44.

            Default value is false.

          • ReadOnlyForceRecursive boolean

            Raise an error if the mount cannot be made recursively read-only.

            Default value is false.

        • VolumeOptions object

          Optional configuration for the volume type.

          Hide VolumeOptions attributes Show VolumeOptions attributes object

          • NoCopy boolean

            Populate volume with data from the target.

            Default value is false.

          • Labels object

            User-defined key/value metadata.

            Hide Labels attribute Show Labels attribute object

            • * string Additional properties
          • DriverConfig object

            Map of driver specific options

            Hide DriverConfig attributes Show DriverConfig attributes object

            • Name string

              Name of the driver to use to create the volume.

            • Options object

              key/value map of driver specific options.

              Hide Options attribute Show Options attribute object

              • * string Additional properties
          • Subpath string

            Source path inside the volume. Must be relative without any back traversals.

        • ImageOptions object

          Optional configuration for the image type.

          Hide ImageOptions attribute Show ImageOptions attribute object

          • Subpath string

            Source path inside the image. Must be relative without any back traversals.

        • TmpfsOptions object

          Optional configuration for the tmpfs type.

          Hide TmpfsOptions attributes Show TmpfsOptions attributes object

          • SizeBytes integer(int64)

            The size for the tmpfs mount in bytes.

          • Mode integer

            The permission mode for the tmpfs mount in an integer.

          • Options array[array]

            The options to be passed to the tmpfs mount. An array of arrays. Flag options should be provided as 1-length arrays. Other types should be provided as as 2-length arrays, where the first item is the key and the second the value.

            At least 1 but not more than 2 elements.

      • StopSignal string

        Signal to stop the container.

      • StopGracePeriod integer(int64)

        Amount of time to wait for the container to terminate before forcefully killing it.

      • HealthCheck object

        A test to perform to check that the container is healthy.

        Hide HealthCheck attributes Show HealthCheck attributes object

        • Test array[string]

          The test to perform. Possible values are:

          • [] inherit healthcheck from image or parent image
          • ["NONE"] disable healthcheck
          • ["CMD", args...] exec arguments directly
          • ["CMD-SHELL", command] run command with system's default shell
        • Interval integer(int64)

          The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

        • Timeout integer(int64)

          The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

        • Retries integer

          The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.

        • StartPeriod integer(int64)

          Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

        • StartInterval integer(int64)

          The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

      • Hosts array[string]

        A list of hostname/IP mappings to add to the container's hosts file. The format of extra hosts is specified in the hosts(5) man page:

        IP_address canonical_hostname [aliases...]

      • DNSConfig object

        Specification for DNS related configurations in resolver configuration file (resolv.conf).

        Hide DNSConfig attributes Show DNSConfig attributes object

        • Nameservers array[string]

          The IP addresses of the name servers.

        • Search array[string]

          A search list for host-name lookup.

        • Options array[string]

          A list of internal resolver variables to be modified (e.g., debug, ndots:3, etc.).

      • Secrets array[object]

        Secrets contains references to zero or more secrets that will be exposed to the service.

        Hide Secrets attributes Show Secrets attributes object

        • File object

          File represents a specific target that is backed by a file.

          Hide File attributes Show File attributes object

          • Name string

            Name represents the final filename in the filesystem.

          • UID string

            UID represents the file UID.

          • GID string

            GID represents the file GID.

          • Mode integer(uint32)

            Mode represents the FileMode of the file.

        • SecretID string

          SecretID represents the ID of the specific secret that we're referencing.

        • SecretName string

          SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID.

      • OomScoreAdj integer(int64)

        An integer value containing the score given to the container in order to tune OOM killer preferences.

      • Configs array[object]

        Configs contains references to zero or more configs that will be exposed to the service.

        Hide Configs attributes Show Configs attributes object

        • File object

          File represents a specific target that is backed by a file.

          
          

          Note: Configs.File and Configs.Runtime are mutually exclusive

          Hide File attributes Show File attributes object

          • Name string

            Name represents the final filename in the filesystem.

          • UID string

            UID represents the file UID.

          • GID string

            GID represents the file GID.

          • Mode integer(uint32)

            Mode represents the FileMode of the file.

        • Runtime object

          Runtime represents a target that is not mounted into the container but is used by the task

          
          

          Note: Configs.File and Configs.Runtime are mutually exclusive

        • ConfigID string

          ConfigID represents the ID of the specific config that we're referencing.

        • ConfigName string

          ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID.

      • Isolation string

        Isolation technology of the containers running the service. (Windows only)

        Values are default, process, hyperv, or .

      • Init boolean

        Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used.

      • Sysctls object

        Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service.

        Hide Sysctls attribute Show Sysctls attribute object

        • * string Additional properties
      • CapabilityAdd array[string]

        A list of kernel capabilities to add to the default set for the container.

      • CapabilityDrop array[string]

        A list of kernel capabilities to drop from the default set for the container.

      • Ulimits array[object]

        A list of resource limits to set in the container. For example: {"Name": "nofile", "Soft": 1024, "Hard": 2048}"

        Hide Ulimits attributes Show Ulimits attributes object

        • Name string

          Name of ulimit

        • Soft integer

          Soft limit

        • Hard integer

          Hard limit

    • NetworkAttachmentSpec object

      Read-only spec type for non-swarm containers attached to swarm overlay networks.

      
      

      Note: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are mutually exclusive. PluginSpec is only used when the Runtime field is set to plugin. NetworkAttachmentSpec is used when the Runtime field is set to attachment.

      Hide NetworkAttachmentSpec attribute Show NetworkAttachmentSpec attribute object

      • ContainerID string

        ID of the container represented by this task

    • Resources object

      Resource requirements which apply to each individual container created as part of the service.

      Hide Resources attributes Show Resources attributes object

      • Limits object

        Define resources limits.

        Hide Limits attributes Show Limits attributes object

        • NanoCPUs integer(int64)
        • MemoryBytes integer(int64)
        • Pids integer(int64)

          Limits the maximum number of PIDs in the container. Set 0 for unlimited.

          Default value is 0.

      • Reservations object

        An object describing the resources which can be advertised by a node and requested by a task.

        Hide Reservations attributes Show Reservations attributes object

        • NanoCPUs integer(int64)
        • MemoryBytes integer(int64)
        • GenericResources array[object]

          User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1).

          Hide GenericResources attributes Show GenericResources attributes object

          • NamedResourceSpec object
            Hide NamedResourceSpec attributes Show NamedResourceSpec attributes object

            • Kind string
            • Value string
          • DiscreteResourceSpec object
            Hide DiscreteResourceSpec attributes Show DiscreteResourceSpec attributes object

            • Kind string
            • Value integer(int64)
    • RestartPolicy object

      Specification for the restart policy which applies to containers created as part of this service.

      Hide RestartPolicy attributes Show RestartPolicy attributes object

      • Condition string

        Condition for restart.

        Values are none, on-failure, or any.

      • Delay integer(int64)

        Delay between restart attempts.

      • MaxAttempts integer(int64)

        Maximum attempts to restart a given container before giving up (default value is 0, which is ignored).

        Default value is 0.

      • Window integer(int64)

        Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded).

        Default value is 0.

    • Placement object
      Hide Placement attributes Show Placement attributes object

      • Constraints array[string]

        An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a match (==) or exclude (!=) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows:

        node attribute	matches	example
        node.id	Node ID	node.id==2ivku8v2gvtg4
        node.hostname	Node hostname	node.hostname!=node-2
        node.role	Node role (manager/worker)	node.role==manager
        node.platform.os	Node operating system	node.platform.os==windows
        node.platform.arch	Node architecture	node.platform.arch==x86_64
        node.labels	User-defined node labels	node.labels.security==high
        engine.labels	Docker Engine's labels	engine.labels.operatingsystem==ubuntu-24.04

        engine.labels apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add node.labels for operational purposes by using the node update endpoint.

      • Preferences array[object]

        Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence.

        Hide Preferences attribute Show Preferences attribute object

        • Spread object
          Hide Spread attribute Show Spread attribute object

          • SpreadDescriptor string

            label descriptor, such as engine.labels.az.

      • MaxReplicas integer(int64)

        Maximum number of replicas for per node (default value is 0, which is unlimited)

        Default value is 0.

      • Platforms array[object]

        Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions.

        Platform represents the platform (Arch/OS).

        Hide Platforms attributes Show Platforms attributes object

        • Architecture string

          Architecture represents the hardware architecture (for example, x86_64).

        • OS string

          OS represents the Operating System (for example, linux or windows).

    • ForceUpdate integer

      A counter that triggers an update even if no relevant parameters have been changed.

    • Runtime string

      Runtime is the type of runtime specified for the task executor.

    • Networks array[object]

      Specifies which networks the service should attach to.

      Specifies how a service should be attached to a particular network.

      Hide Networks attributes Show Networks attributes object

      • Target string

        The target network for attachment. Must be a network name or ID.

      • Aliases array[string]

        Discoverable alternate names for the service on this network.

      • DriverOpts object

        Driver attachment options for the network target.

        Hide DriverOpts attribute Show DriverOpts attribute object

        • * string Additional properties
    • LogDriver object

      Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified.

      Hide LogDriver attributes Show LogDriver attributes object

      • Name string
      • Options object
        Hide Options attribute Show Options attribute object

        • * string Additional properties
  • ServiceID string

    The ID of the service this task is part of.

  • Slot integer
  • NodeID string

    The ID of the node that this task is on.

  • AssignedGenericResources array[object]

    User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1).

    Hide AssignedGenericResources attributes Show AssignedGenericResources attributes object

    • NamedResourceSpec object
      Hide NamedResourceSpec attributes Show NamedResourceSpec attributes object

      • Kind string
      • Value string
    • DiscreteResourceSpec object
      Hide DiscreteResourceSpec attributes Show DiscreteResourceSpec attributes object

      • Kind string
      • Value integer(int64)
  • Status object

    represents the status of a task.

    Hide Status attributes Show Status attributes object

    • Timestamp string(dateTime)
    • State string

      Values are new, allocated, pending, assigned, accepted, preparing, ready, starting, running, complete, shutdown, failed, rejected, remove, or orphaned.

    • Message string
    • Err string
    • ContainerStatus object

      represents the status of a container.

      Hide ContainerStatus attributes Show ContainerStatus attributes object

      • ContainerID string
      • PID integer
      • ExitCode integer
    • PortStatus object

      represents the port status of a task's host ports whose service has published host ports

      Hide PortStatus attribute Show PortStatus attribute object

      • Ports array[object]
        Hide Ports attributes Show Ports attributes object

        • Name string
        • Protocol string

          Values are tcp, udp, or sctp.

        • TargetPort integer

          The port inside the container.

        • PublishedPort integer

          The port on the swarm hosts.

        • PublishMode string

          The mode in which port is published.

          
          

          • "ingress" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not.
          • "host" bypasses the routing mesh and publish the port directly on the swarm node where that service is running.

          Values are ingress or host. Default value is ingress.

  • DesiredState string

    Values are new, allocated, pending, assigned, accepted, preparing, ready, starting, running, complete, shutdown, failed, rejected, remove, or orphaned.

  • JobIteration object

    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.

    Hide JobIteration attribute Show JobIteration attribute object

    • Index integer(uint64)
• 500 application/json

  server error

  Hide response attribute Show response attribute object

  • message string Required

    The error message.

• 503 application/json

  node is not part of a swarm

  Hide response attribute Show response attribute object

  • message string Required

    The error message.