Marathon REST API documentation version 2.0

Query Parameters

• cmd: (string)

  Filter the result to only return apps whose cmd field contains the given value

  Example:

  java

• id: (string)

  Filter the result to only return apps whose id is or contains the given value

  Example:

  /us-east/database/memsql

• label: (string)

  A label selector query contains one or more label selectors, which are comma separated. Marathon supports three types of selectors existence-based, equality-based and set-based. In the case of multiple selectors, all must be satisfied so comma separator acts as an AND logical operator. Labels and values must consist of alphanumeric characters plus - _ and . -A-Za-z0-9_.. Any other character is possible, but must be escaped with a backslash character.

  • Existence based Selector Query Matches the existence of a label
    Example: my_label,environment
  • Equality based Selector Query Matches existence of labels and the (non) equality of the value.
    Example: environment==production, tier!=frontend
  • Set based Selector Query Matches existence of labels and the (non) existence of the value in a given set
    Example: environment in (stage,production), tier notin (frontend, service)

  Example:

  my_label, environment==production, tier!=frontend\ tier, deployed in (us, eu), deployed notin (aa, bb)

• embed: (one of apps.tasks, apps.count, apps.deployments, apps.lastTaskFailure, apps.failures, apps.taskStats - repeat: true)

  Embeds nested resources that match the supplied path. You can specify this parameter multiple times with different values.

  • apps.tasks embed all tasks of each application
    Note: if this embed is definded, it automatically sets apps.deployments but this will change in a future release. Please define all embeds explicitly.
  • apps.counts embed all task counts (tasksStaged, tasksRunning, tasksHealthy, tasksUnhealthy)
    Note: currently embedded by default but this will change in a future release. Please define all embeds explicitly.
  • apps.deployments embed all deployment identifier, if the related app currently is in deployment.
  • apps.readiness embed all readiness check results
  • apps.lastTaskFailure embeds the lastTaskFailure for the application if there is one.
  • apps.failures Shorthand for apps.lastTaskFailure, apps.tasks, apps.counts and apps.deployments.
    Note: deprecated and will be removed in future versions Please define all embeds explicitly.
  • apps.taskStats exposes task statatistics in the JSON.

  Example:

  apps.tasks

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

Body

Type: application/json

Example:

[{
  "id": "/test/sleep60",
  "cmd": "sleep 60",
  "cpus": 0.3,
  "instances": 2,
  "mem": 9,
  "dependencies": [ "/test/sleep120",  "/other/namespace/or/app"]
},{
  "id": "/test/sleep120",
  "cmd": "sleep 120",
  "cpus": 0.3,
  "instances": 2,
  "mem": 9
}]

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/schema#",
  "additionalProperties": false,
  "definitions": {
    "pathType": {
      "type": "string",
      "pattern": "^(\\/?((\\.{2})|([a-z0-9][a-z0-9\\-.]*[a-z0-9]+)|([a-z0-9]*))($|\\/))+$",
      "minLength": 1
    }
  },
  "not": {
    "allOf": [
      {
        "required": [
          "cmd"
        ]
      },
      {
        "required": [
          "args"
        ]
      }
    ]
  },
  "properties": {
    "acceptedResourceRoles": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "Optional. A list of resource roles. Marathon considers only resource offers with roles in this list for launching tasks of this app. If you do not specify this, Marathon considers all resource offers with roles that have been configured by the `--default_accepted_resource_roles` command line flag. If no `--default_accepted_resource_roles` was given on startup, Marathon considers all resource offers. To register Marathon for a role, you need to specify the `--mesos_role` command line flag on startup. If you want to assign all resources of a slave to a role, you can use the `--default_role` argument when starting up the slave. If you need a more fine-grained configuration, you can use the `--resources` argument to specify resource shares per role. See [the Mesos attribute and resources documentation](http://mesos.apache.org/documentation/latest/attributes-resources/) for details."
    },
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "An array of strings that represents an alternative mode of specifying the command to run. This was motivated by safe usage of containerizer features like a custom Docker ENTRYPOINT. This args field may be used in place of cmd even when using the default command executor. This change mirrors API and semantics changes in the Mesos CommandInfo protobuf message starting with version `0.20.0`.  Either `cmd` or `args` must be supplied. It is invalid to supply both `cmd` and `args` in the same app."
    },
    "backoffFactor": {
      "minimum": 1.0,
      "type": "number",
      "description": "Configures exponential backoff behavior when launching potentially sick apps. This prevents sandboxes associated with consecutively failing tasks from filling up the hard disk on Mesos slaves. The backoff period is multiplied by the factor for each consecutive failure until it reaches maxLaunchDelaySeconds. This applies also to tasks that are killed due to failing too many health checks."
    },
    "backoffSeconds": {
      "description": "Configures exponential backoff behavior when launching potentially sick apps. This prevents sandboxes associated with consecutively failing tasks from filling up the hard disk on Mesos slaves. The backoff period is multiplied by the factor for each consecutive failure until it reaches maxLaunchDelaySeconds. This applies also to tasks that are killed due to failing too many health checks.",
      "minimum": 0,
      "type": "integer"
    },
    "cmd": {
      "description": "The command that is executed.  This value is wrapped by Mesos via `/bin/sh -c ${app.cmd}`.  Either `cmd` or `args` must be supplied. It is invalid to supply both `cmd` and `args` in the same app.",
      "type": "string",
      "minLength": 1
    },
    "constraints": {
      "type": "array",
      "items": {
        "type": "array",
        "items": [
          {
            "type": "string"
          },
          {
            "type": "string",
            "enum": ["UNIQUE", "CLUSTER", "GROUP_BY", "LIKE", "UNLIKE", "MAX_PER"]
          },
          {
            "type": "string"
          }
        ],
        "minItems": 2,
        "additionalItems": false
      },
      "description": "Valid constraint operators are one of UNIQUE, CLUSTER, GROUP_BY, LIKE, UNLIKE, MAX_PER."
    },
    "container": {
      "additionalProperties": false,
      "properties": {
        "docker": {
          "additionalProperties": false,
          "properties": {
            "credential": {
              "type": "object",
              "description": "Credential to authenticate with the docker registry.",
              "additionalProperties": false,
              "properties": {
                "principal": {
                  "type": "string",
                  "description": "Principal to authenticate with the docker registry."
                },
                "secret": {
                  "type": "string",
                  "description": "Secret to authenticate with the docker registry."
                }
              },
              "required": [ "principal" ]
            },
            "forcePullImage": {
              "type": "boolean",
              "description": "The container will be pulled, regardless if it is already available on the local system."
            },
            "image": {
              "type": "string",
              "minLength": 1,
              "description": "The name of the docker image to use."
            },
            "network": {
              "type": "string",
              "description": "The networking mode, this container should operate in. One of BRIDGE|HOST|NONE|USER",
              "enum": ["BRIDGE", "HOST", "NONE", "USER"]
            },
            "parameters": {
              "type": "array",
              "description": "Allowing arbitrary parameters to be passed to docker CLI. Note that anything passed to this field is not guaranteed to be supported moving forward, as we might move away from the docker CLI.",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "key": {
                    "type": "string",
                    "minLength": 1,
                    "description": "Key of this parameter"
                  },
                  "value": {
                    "type": "string",
                    "description": "Value of this parameter"
                  }
                },
                "required": [ "key", "value" ]
              }
            },
            "portMappings": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "containerPort": {
                    "type": "integer",
                    "description": "Refers to the port the application listens to inside of the container. It is optional and defaults to 0. For each containerPort with a value of 0 Marathon assigns the containerPort the same value as the assigned hostPort. This is especially useful for apps that advertise the port they are listening on to the outside world for P2P communication. Without containerPort: 0 they would erroneously advertise their private container port which is usually not the same as the externally visible host port.",
                    "maximum": 65535,
                    "minimum": 0
                  },
                  "hostPort": {
                    "type": "integer",
                    "description": "Retains the traditional meaning in Marathon, which is a random port from the range included in the Mesos resource offer. The resulting host ports for each task are exposed via the task details in the REST API and the Marathon web UI. hostPort is optional. In BRIDGE mode it defaults to 0 if left unspecified. In USER mode an unspecified hostPort does not allocate a port from a Mesos offer.",
                    "maximum": 65535,
                    "minimum": 0
                  },
                  "labels": {
                    "type": "object",
                    "description": "This can be used to add metadata to be interpreted by external applications such as firewalls.",
                    "additionalProperties": {
                      "type": "string"
                    }
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of the service hosted on this port. If provided, it must be unique over all port mappings.",
                    "pattern": "^[a-z][a-z0-9-]*$"
                  },
                  "protocol": {
                    "type": "string",
                    "enum": ["tcp", "udp", "udp,tcp"],
                    "description": "Protocol of the port (one of ['tcp', 'udp'] or 'udp,tcp' for both). Defaults to 'tcp'."
                  },
                  "servicePort": {
                    "type": "integer",
                    "description": "Is a helper port intended for doing service discovery using a well-known port per service. The assigned servicePort value is not used/interpreted by Marathon itself but supposed to used by load balancer infrastructure. See Service Discovery Load Balancing doc page. The servicePort parameter is optional and defaults to 0. Like hostPort, If the value is 0, a random port will be assigned. If a servicePort value is assigned by Marathon then Marathon guarantees that its value is unique across the cluster. The values for random service ports are in the range [local_port_min, local_port_max] where local_port_min and local_port_max are command line options with default values of 10000 and 20000, respectively.",
                    "maximum": 65535,
                    "minimum": 0
                  }
                }
              }
            },
            "privileged": {
              "type": "boolean",
              "description": "Run this docker image in privileged mode."
            }
          },
          "required": [
            "image"
          ],
          "type": "object"
        },
        "appc": {
          "additionalProperties": false,
          "properties": {
            "image": {
              "type": "string",
              "minLength": 1,
              "description": "The name of the AppC image to use."
            },
            "id": {
              "type": "string",
              "minLength": 7,
              "description": "An image ID is a string of the format 'hash-value', where 'hash' is the hash algorithm used and 'value' is the hex-encoded digest. Currently the only permitted hash algorithm is sha512."
            },
            "labels": {
              "type": "object",
              "description": "Optional labels. Suggested labels: 'version', 'os', and 'arch'.",
              "additionalProperties": {
                "type": "string"
              }
            },
            "forcePullImage": {
              "type": "boolean",
              "description": "The container will be pulled, regardless if it is already available on the local system."
            }
          },
          "required": [ "image" ],
          "type": "object"
        },
        "type": {
          "type": "string",
          "description": "Container engine type. Supported engine types at the moment are DOCKER and MESOS.",
          "enum": ["MESOS", "DOCKER"]
        },
        "volumes": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "containerPath": {
                "type": "string",
                "description": "The path of the volume in the container",
                "minLength": 1
              },
              "hostPath": {
                "type": "string",
                "description": "The path of the volume on the host",
                "minLength": 1
              },
              "persistent": {
                "additionalProperties": false,
                "properties": {
                  "size": {
                    "type": "integer",
                    "description": "The size of the persistent volume in MiB",
                    "minimum": 0
                  }
                },
                "type": "object"
              },
              "external": {
                "additionalProperties": false,
                "properties": {
                  "size": {
                    "type": "integer",
                    "description": "The size of the external volume in MiB",
                    "minimum": 0
                  },
                  "name": {
                    "type": "string",
                    "description": "The name of the volume"
                  },
                  "provider": {
                    "type": "string",
                    "description": "The name of the volume provider"
                  },
                  "options": {
                    "type": "object",
                    "description": "Provider-specific volume configuration options"
                  }
                },
                "type": "object"
              },
              "mode": {
                "type": "string",
                "description": "Possible values are RO for ReadOnly and RW for Read/Write",
                "enum": ["RO", "RW"]
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "cpus": {
      "type": "number",
      "description": "The number of CPU shares this application needs per instance. This number does not have to be integer, but can be a fraction.",
      "minimum": 0
    },
    "dependencies": {
      "type": "array",
      "description": "A list of services upon which this application depends. An order is derived from the dependencies for performing start/stop and upgrade of the application. For example, an application /a relies on the services /b which itself relies on /c. To start all 3 applications, first /c is started than /b than /a.",
      "items": {
        "$ref": "#/definitions/pathType"
      }
    },
    "disk": {
      "type": "number",
      "description": "How much disk space in MB is needed for this application. This number does not have to be an integer, but can be a fraction.",
      "minimum": 0
    },
    "env": {
      "patternProperties": {
        ".*": {
          "oneOf": [
            { "type": "string" },
            {
              "type": "object",
              "description": "An environment variable set to a secret.",
              "properties": {
                "secret": {
                  "type": "string",
                  "description": "The key of the secret to be used as a value.",
                  "minLength": 1
                }
              },
              "required": [ "secret" ],
              "additionalProperties": false
            }
          ]
        }
      },
      "type": "object"
    },
    "executor": {
      "type": "string",
      "description": "The executor to use to launch this application. Different executors are available. The simplest one (and the default if none is given) is //cmd, which takes the cmd and executes that on the shell level.",
      "pattern": "^(|\\/\\/cmd|\\/?[^\\/]+(\\/[^\\/]+)*)$"
    },
    "fetch": {
      "type": "array",
      "description": "Provided URIs are passed to Mesos fetcher module and resolved in runtime.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "uri": {
            "type": "string",
            "description": "URI to be fetched by Mesos fetcher module"
          },
          "executable": {
            "type": "boolean",
            "description": "Set fetched artifact as executable"
          },
          "extract": {
            "type": "boolean",
            "description": "Extract fetched artifact if supported by Mesos fetcher module"
          },
          "cache": {
            "type": "boolean",
            "description": "Cache fetched artifact if supported by Mesos fetcher module"
          },
          "outputFile": {
            "type": "string",
            "description": "Rename fetched artifact with the given name"
          }
        },
        "required": [ "uri" ]
      }
    },
    "healthChecks": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "command": {
            "type": "object",
            "items": {
              "additionalProperties": false,
              "properties": {
                "value": {
                  "type": "string",
                  "description": "The health check command to execute."
                }
              }
            }
          },
          "gracePeriodSeconds": {
            "type": "integer",
            "description": "Health check failures are ignored within this number of seconds of the task being started or until the task becomes healthy for the first time.",
            "minimum": 0
          },
          "ignoreHttp1xx": {
            "type": "boolean",
            "description": "Ignore HTTP 1xx responses."
          },
          "intervalSeconds": {
            "type": "integer",
            "description": "Number of seconds to wait between health checks.",
            "minimum": 0
          },
          "maxConsecutiveFailures": {
            "type": "integer",
            "description": "Number of consecutive health check failures after which the unhealthy task should be killed.",
            "minimum": 0
          },
          "path": {
            "type": "string",
            "description": "Path to endpoint exposed by the task that will provide health status. Example: /path/to/health. Note: only used if protocol == HTTP[S]."
          },
          "port": {
            "type": "integer",
            "description": "The specific port to connect to. In case of dynamic ports, see portIndex.",
            "maximum": 65535,
            "minimum": 0
          },
          "portIndex": {
            "type": "integer",
            "description": "Index in this app's ports array to be used for health requests. An index is used so the app can use random ports, like [0, 0, 0] for example, and tasks could be started with port environment variables like $PORT1.",
            "minimum": 0
          },
          "protocol": {
            "type": "string",
            "description": "Protocol of the requests to be performed. One of HTTP, HTTPS, TCP or COMMAND.",
            "enum": ["HTTP", "HTTPS", "TCP", "COMMAND"]
          },
          "timeoutSeconds": {
            "type": "integer",
            "description": "Number of seconds after which a health check is considered a failure regardless of the response.",
            "minimum": 0
          }
        }
      },
      "type": "array"
    },
    "id": {
      "$ref": "#/definitions/pathType",
      "description": "Unique identifier for the app consisting of a series of names separated by slashes. Each name must be at least 1 character and may only contain digits (`0-9`), dashes (`-`), dots (`.`), and lowercase letters (`a-z`). The name may not begin or end with a dash."
    },
    "instances": {
      "type": "integer",
      "description": "The number of instances of this application to start. Please note: this number can be changed any time as needed to scale the application.",
      "minimum": 0
    },
    "labels": {
      "type": "object",
      "description": "Attaching metadata to apps can be useful to expose additional information to other services, so we added the ability to place labels on apps (for example, you could label apps staging and production to mark services by their position in the pipeline).",
      "additionalProperties": {
        "type": "string"
      }
    },
    "maxLaunchDelaySeconds": {
      "type": "integer",
      "description": "Configures exponential backoff behavior when launching potentially sick apps. This prevents sandboxes associated with consecutively failing tasks from filling up the hard disk on Mesos slaves. The backoff period is multiplied by the factor for each consecutive failure until it reaches maxLaunchDelaySeconds. This applies also to tasks that are killed due to failing too many health checks.",
      "minimum": 0
    },
    "mem": {
      "type": "number",
      "description": "The amount of memory in MB that is needed for the application per instance.",
      "minimum": 0
    },
    "gpus": {
     "type": "integer",
     "description": "The amount of GPU cores that is needed for the application per instance.",
     "minimum": 0
    },
    "ipAddress": {
      "type": "object",
      "description": "If an application definition includes the 'ipAddress' field, then Marathon will request a per-task IP from Mesos. A separate ports/portMappings configuration is then disallowed.",
      "properties": {
        "discovery": {
          "type": "object",
          "description": "Information useful for service discovery.",
          "properties": {
            "ports": {
              "type": "array",
              "description": "Array of objects describing the ports exposed by each task.",
              "items": {
                "type": "object",
                "description": "Port",
                "properties": {
                  "number": {
                    "maximum": 65535,
                    "minimum": 0,
                    "type": "integer",
                    "description": "The port number."
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of the port.",
                    "pattern": "^[a-z][a-z0-9-]*$"
                  },
                  "protocol": {
                    "enum": ["tcp", "udp"],
                    "description": "Protocol of the port (one of ['tcp', 'udp'])."
                  }
                }
              }
            }
          }
        },
        "groups": {
          "type": "array",
          "description": "Array of network groups. One IP address can belong to zero or more network groups. The idea is that containers can only reach containers with which they share at least one network group.",
          "items": {
            "type": "string",
            "description": "The name of the network group."
          }
        },
        "labels": {
          "type": "object",
          "description": "Key value pair for meta data on that network interface.",
          "properties": {},
          "additionalProperties": true
        },
        "networkName": {
          "type": "string",
          "description": "If present, declares the name of the network that the container should join. In practice it is up to the IPAM to decide how to interpret this field."
        }
      }
    },
    "ports": {
      "type": "array",
      "description": "An array of required port resources on the agent host. The number of items in the array determines how many dynamic ports are allocated for every task. For every port that is zero, a globally unique (cluster-wide) port is assigned and provided as part of the app definition to be used in load balancing definitions.",
      "items": {
        "maximum": 65535,
        "minimum": 0,
        "type": "integer"
      }
    },
    "portDefinitions": {
      "type": "array",
      "description": "An array of required port resources on the agent host. The number of items in the array determines how many dynamic ports are allocated for every task. For every port definition with port number zero, a globally unique (cluster-wide) service port is assigned and provided as part of the app definition to be used in load balancing definitions.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "port": {
            "type": "integer",
            "description": "if requirePorts is set to true, then this port number will be used on the agent host Otherwise if the requirePorts is set to false and this port number is not zero, then it will be used as a service port and a dynamic port will be used on the agent host. If it is set to zero, a dynamic port will be used on the host and a unique service port will be assigned by Marathon.",
            "maximum": 65535,
            "minimum": 0
          },
          "labels": {
            "type": "object",
            "description": "This can be used to add metadata to be interpreted by external applications such as firewalls.",
            "additionalProperties": {
              "type": "string"
            }
          },
          "name": {
            "type": "string",
            "description": "Name of the service hosted on this port. If provided, it must be unique over all port definitions.",
            "pattern": "^[a-z][a-z0-9-]*$"
          },
          "protocol": {
            "type": "string",
            "enum": ["tcp", "udp"],
            "description": "Protocol of the port (one of ['tcp', 'udp']). Defaults to 'tcp'."
          }
        }
      }
    },
    "readinessChecks": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "Query these readiness checks to determine if a task is ready to serve requests.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name used to identify this readiness check."
          },
          "protocol": {
            "type": "string",
            "description": "Protocol of the requests to be performed. One of HTTP, HTTPS.",
            "enum": ["HTTP", "HTTPS"]
          },
          "path": {
            "type": "string",
            "description": "Path to endpoint exposed by the task that will provide readiness status. Example: /path/to/health."
          },
          "portName": {
            "type": "string",
            "description": "Name of the port to query as described in the portDefinitions. Example: http-api."
          },
          "intervalSeconds": {
            "type": "integer",
            "description": "Number of seconds to wait between readiness checks. Defaults to 30 seconds",
            "minimum": 0
          },
          "timeoutSeconds": {
            "type": "integer",
            "description": "Number of seconds after which a health check is considered a failure regardless of the response. Must be smaller than intervalSeconds. Defaults to 10 seconds.",
            "minimum": 0
          },
          "httpStatusCodesForReady": {
            "items": {
              "type": "integer",
              "minimum": 100,
              "maximum": 999
            },
            "description": "The HTTP(s) status code to treat as 'ready'.",
            "type": "array"
          },
          "preserveLastResponse": {
            "type": "boolean",
            "description": "If and only if true, preserve the last readiness check responses and expose them in the API as part of a deployment.."
          }
        }
      },
      "type": "array"
    },
    "residency": {
      "type": "object",
      "description": "When using local persistent volumes that pin tasks onto agents, these values define how Marathon handles terminal states of these tasks.",
      "properties": {
        "relaunchEscalationTimeoutSeconds": {
          "type": "integer",
          "description": "When a task using persistent local volumes cannot be restarted on the agent it's been pinned to, Marathon will try to launch this task on another node after this timeout. Defaults to 3600 (one hour).",
          "minimum": 0,
          "additionalProperties": false
        },
        "taskLostBehavior": {
          "type": "string",
          "description": "When Marathon receives a TASK_LOST status update indicating that the agent running the task is gone, this property defines whether Marathon will launch the task on another node or not. Defaults to WAIT_FOREVER",
          "enum": ["WAIT_FOREVER", "RELAUNCH_AFTER_TIMEOUT"],
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "requirePorts": {
      "type": "boolean",
      "description": "Normally, the host ports of your tasks are automatically assigned. This corresponds to the requirePorts value false which is the default. If you need more control and want to specify your host ports in advance, you can set requirePorts to true. This way the ports you have specified are used as host ports. That also means that Marathon can schedule the associated tasks only on hosts that have the specified ports available."
    },
    "secrets": {
      "type": "object",
      "description": "A map with named secret declarations. The key is used to reference the values from other places in the app definition.",
      "patternProperties": {
        ".*": {
          "type": "object",
          "description": "A secret declaration.",
          "properties": {
            "source": {
              "type": "string",
              "description": "The source of the secret's value. The format depends on the secret store used by Mesos.",
              "minLength": 1
            }
          },
          "required": [ "source" ],
          "additionalProperties": false
        }
      }
    },
    "storeUrls": {
      "type": "array",
      "description": "URL's that have to be resolved and put into the artifact store, before the task will be started.",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "taskKillGracePeriodSeconds": {
      "type": "integer",
      "description": "Configures the number of seconds between escalating from SIGTERM to SIGKILL when signalling tasks to terminate. Using this grace period, tasks should perform orderly shut down immediately upon receiving SIGTERM.",
      "minimum": 0
    },
    "upgradeStrategy": {
      "type": "object",
      "description": "During an upgrade all instances of an application get replaced by a new version. The upgradeStrategy controls how Marathon stops old versions and launches new versions.",
      "additionalProperties": false,
      "properties": {
        "maximumOverCapacity": {
          "type": "number",
          "description": "A number between 0 and 1 which is multiplied with the instance count. This is the maximum number of additional instances launched at any point of time during the upgrade process.",
          "maximum": 1.0,
          "minimum": 0.0
        },
        "minimumHealthCapacity": {
          "type": "number",
          "description": "A number between 0 and 1 that is multiplied with the instance count. This is the minimum number of healthy nodes that do not sacrifice overall application purpose. Marathon will make sure, during the upgrade process, that at any point of time this number of healthy instances are up.",
          "maximum": 1.0,
          "minimum": 0.0
        }
      }
    },
    "uris": {
      "type": "array",
      "description": "URIs defined here are resolved, before the application gets started. If the application has external dependencies, they should be defined here.",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "user": {
      "type": "string",
      "description": "The user to use to run the tasks on the agent."
    },
    "version": {
      "type": "string",
      "description": "The version of this definition.",
      "format": "date-time"
    },
    "versionInfo": {
      "type": "object",
      "description": "Detailed version information.",
      "additionalProperties": false,
      "properties": {
        "lastScalingAt": {
          "type": "string",
          "description": "Contains the time stamp of the last change to this app which was not simply a scaling or a restarting configuration.",
          "format": "date-time"
        },
        "lastConfigChangeAt": {
          "type": "string",
          "description": "Contains the time stamp of the last change including changes like scaling or restarting the app. Since our versions are time based, this is currently equal to version.",
          "format": "date-time"
        }
      }
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Example:

{
  "id": "/foo",
  "instances": 2,
  "cmd": "sleep 1000",
  "cpus": 0.1,
  "disk": 0,
  "mem": 16,
  "acceptedResourceRoles": [
    "mesos_role"
  ],
  "args": [
    "sleep",
    "100"
  ],
  "backoffFactor": 1.15,
  "backoffSeconds": 1,
  "constraints": [
    [
      "hostname",
      "LIKE",
      "srv2.*"
    ]
  ],
  "container": {
    "docker": {
      "forcePullImage": false,
      "image": "mesosphere:marathon/latest",
      "network": "BRIDGE",
      "parameters": [
        {
          "key": "name",
          "value": "kdc"
        }
      ],
      "portMappings": [
        {
          "containerPort": 80,
          "hostPort": 0,
          "protocol": "tcp",
          "servicePort": 10019,
          "name": "http",
          "labels": { "vip": "192.168.0.1:80" }
        }
      ],
      "privileged": false
    },
    "type": "DOCKER",
    "volumes": [
      {
        "containerPath": "/docker_storage",
        "hostPath": "/hdd/tools/docker/registry",
        "mode": "RW"
      }
    ]
  },
  "dependencies": [
    "/prod/group"
  ],
  "env": {
    "XPS1": "Test",
    "XPS2": "Rest",
    "PASSWORD": { "secret": "/db/password" }
  },
  "executor": "",
  "healthChecks": [
    {
      "gracePeriodSeconds": 300,
      "ignoreHttp1xx": false,
      "intervalSeconds": 20,
      "maxConsecutiveFailures": 3,
      "path": "/",
      "portIndex": 0,
      "protocol": "HTTP",
      "timeoutSeconds": 20
    }
  ],
  "readinessChecks": [
    {
      "name": "myReadyCheck",
      "protocol": "HTTP",
      "path": "/v1/plan",
      "portName": "http",
      "intervalSeconds": 10,
      "timeoutSeconds": 3,
      "httpStatusCodesForReady": [ 200 ],
      "preserveLastResponse": true
    }
  ],
  "labels": {
    "owner": "zeus",
    "note": "Away from olympus"
  },
  "maxLaunchDelaySeconds": 3600,
  "ipAddress": {
    "discovery": {
      "ports": [
        {
          "number": 8080,
          "name": "rest_endpoint",
          "protocol": "tcp"
        }
      ]
    },
    "groups": [
      "dev"
    ],
    "labels": {
      "environment": "dev"
    }
  },
  "portDefinitions": [
    {
      "port": 0,
      "protocol": "tcp",
      "name": "http",
      "labels": { "vip": "192.168.0.1:80" }
    }
  ],
  "requirePorts": false,
  "upgradeStrategy": {
    "maximumOverCapacity": 1,
    "minimumHealthCapacity": 1
  },
  "fetch": [
    { "uri": "https://foo.com/setup.py" },
    { "uri": "https://foo.com/archive.zip", "executable": false, "extract": true, "cache": true, "outputFile": "newname.zip" }
  ],
  "user": "root",
  "secrets": {
    "secret1": { "source": "/db/password" },
    "secret3": { "source": "/foo2" }
  },
  "taskKillGracePeriodSeconds": 30
}

URI Parameters

• app_id: required (string)

Query Parameters

• embed: (one of app.tasks, app.count, app.deployments, app.lastTaskFailure, app.failures, app.taskStats - repeat: true)

  Embeds nested resources that match the supplied path. You can specify this parameter multiple times with different values.
  

  • app.tasks. embed tasks Note: if this embed is definded, it automatically sets apps.deployments but this will change in a future release. Please define all embeds explicitly.
  • app.counts. embed all task counts (tasksStaged, tasksRunning, tasksHealthy, tasksUnhealthy)
    Note: currently embedded by default but this will change in a future release. Please define all embeds explicitly.
  • app.deployments. embed all deployment identifier, if the related app currently is in deployment.
  • app.readiness embed all readiness check results
  • app.lastTaskFailure embeds the lastTaskFailure for the application if there is one.
  • app.failures Shorthand for apps.lastTaskFailure, apps.tasks, apps.counts and apps.deployments.
    Note: deprecated and will be removed in future versions Please define all embeds explicitly.
  • app.taskStats exposes task statatistics in the JSON.

  Example:

  embed=app.deployments&embed=app.lastTaskFailure

URI Parameters

• app_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/schema#",
  "additionalProperties": false,
  "definitions": {
    "pathType": {
      "type": "string",
      "pattern": "^(\\/?((\\.{2})|([a-z0-9][a-z0-9\\-.]*[a-z0-9]+)|([a-z0-9]*))($|\\/))+$",
      "minLength": 1
    }
  },
  "not": {
    "allOf": [
      {
        "required": [
          "cmd"
        ]
      },
      {
        "required": [
          "args"
        ]
      }
    ]
  },
  "properties": {
    "acceptedResourceRoles": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "Optional. A list of resource roles. Marathon considers only resource offers with roles in this list for launching tasks of this app. If you do not specify this, Marathon considers all resource offers with roles that have been configured by the `--default_accepted_resource_roles` command line flag. If no `--default_accepted_resource_roles` was given on startup, Marathon considers all resource offers. To register Marathon for a role, you need to specify the `--mesos_role` command line flag on startup. If you want to assign all resources of a slave to a role, you can use the `--default_role` argument when starting up the slave. If you need a more fine-grained configuration, you can use the `--resources` argument to specify resource shares per role. See [the Mesos attribute and resources documentation](http://mesos.apache.org/documentation/latest/attributes-resources/) for details."
    },
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "An array of strings that represents an alternative mode of specifying the command to run. This was motivated by safe usage of containerizer features like a custom Docker ENTRYPOINT. This args field may be used in place of cmd even when using the default command executor. This change mirrors API and semantics changes in the Mesos CommandInfo protobuf message starting with version `0.20.0`.  Either `cmd` or `args` must be supplied. It is invalid to supply both `cmd` and `args` in the same app."
    },
    "backoffFactor": {
      "minimum": 1.0,
      "type": "number",
      "description": "Configures exponential backoff behavior when launching potentially sick apps. This prevents sandboxes associated with consecutively failing tasks from filling up the hard disk on Mesos slaves. The backoff period is multiplied by the factor for each consecutive failure until it reaches maxLaunchDelaySeconds. This applies also to tasks that are killed due to failing too many health checks."
    },
    "backoffSeconds": {
      "description": "Configures exponential backoff behavior when launching potentially sick apps. This prevents sandboxes associated with consecutively failing tasks from filling up the hard disk on Mesos slaves. The backoff period is multiplied by the factor for each consecutive failure until it reaches maxLaunchDelaySeconds. This applies also to tasks that are killed due to failing too many health checks.",
      "minimum": 0,
      "type": "integer"
    },
    "cmd": {
      "description": "The command that is executed.  This value is wrapped by Mesos via `/bin/sh -c ${app.cmd}`.  Either `cmd` or `args` must be supplied. It is invalid to supply both `cmd` and `args` in the same app.",
      "type": "string",
      "minLength": 1
    },
    "constraints": {
      "type": "array",
      "items": {
        "type": "array",
        "items": [
          {
            "type": "string"
          },
          {
            "type": "string",
            "enum": ["UNIQUE", "CLUSTER", "GROUP_BY", "LIKE", "UNLIKE", "MAX_PER"]
          },
          {
            "type": "string"
          }
        ],
        "minItems": 2,
        "additionalItems": false
      },
      "description": "Valid constraint operators are one of UNIQUE, CLUSTER, GROUP_BY, LIKE, UNLIKE, MAX_PER."
    },
    "container": {
      "additionalProperties": false,
      "properties": {
        "docker": {
          "additionalProperties": false,
          "properties": {
            "credential": {
              "type": "object",
              "description": "Credential to authenticate with the docker registry.",
              "additionalProperties": false,
              "properties": {
                "principal": {
                  "type": "string",
                  "description": "Principal to authenticate with the docker registry."
                },
                "secret": {
                  "type": "string",
                  "description": "Secret to authenticate with the docker registry."
                }
              },
              "required": [ "principal" ]
            },
            "forcePullImage": {
              "type": "boolean",
              "description": "The container will be pulled, regardless if it is already available on the local system."
            },
            "image": {
              "type": "string",
              "minLength": 1,
              "description": "The name of the docker image to use."
            },
            "network": {
              "type": "string",
              "description": "The networking mode, this container should operate in. One of BRIDGE|HOST|NONE|USER",
              "enum": ["BRIDGE", "HOST", "NONE", "USER"]
            },
            "parameters": {
              "type": "array",
              "description": "Allowing arbitrary parameters to be passed to docker CLI. Note that anything passed to this field is not guaranteed to be supported moving forward, as we might move away from the docker CLI.",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "key": {
                    "type": "string",
                    "minLength": 1,
                    "description": "Key of this parameter"
                  },
                  "value": {
                    "type": "string",
                    "description": "Value of this parameter"
                  }
                },
                "required": [ "key", "value" ]
              }
            },
            "portMappings": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "containerPort": {
                    "type": "integer",
                    "description": "Refers to the port the application listens to inside of the container. It is optional and defaults to 0. For each containerPort with a value of 0 Marathon assigns the containerPort the same value as the assigned hostPort. This is especially useful for apps that advertise the port they are listening on to the outside world for P2P communication. Without containerPort: 0 they would erroneously advertise their private container port which is usually not the same as the externally visible host port.",
                    "maximum": 65535,
                    "minimum": 0
                  },
                  "hostPort": {
                    "type": "integer",
                    "description": "Retains the traditional meaning in Marathon, which is a random port from the range included in the Mesos resource offer. The resulting host ports for each task are exposed via the task details in the REST API and the Marathon web UI. hostPort is optional. In BRIDGE mode it defaults to 0 if left unspecified. In USER mode an unspecified hostPort does not allocate a port from a Mesos offer.",
                    "maximum": 65535,
                    "minimum": 0
                  },
                  "labels": {
                    "type": "object",
                    "description": "This can be used to add metadata to be interpreted by external applications such as firewalls.",
                    "additionalProperties": {
                      "type": "string"
                    }
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of the service hosted on this port. If provided, it must be unique over all port mappings.",
                    "pattern": "^[a-z][a-z0-9-]*$"
                  },
                  "protocol": {
                    "type": "string",
                    "enum": ["tcp", "udp", "udp,tcp"],
                    "description": "Protocol of the port (one of ['tcp', 'udp'] or 'udp,tcp' for both). Defaults to 'tcp'."
                  },
                  "servicePort": {
                    "type": "integer",
                    "description": "Is a helper port intended for doing service discovery using a well-known port per service. The assigned servicePort value is not used/interpreted by Marathon itself but supposed to used by load balancer infrastructure. See Service Discovery Load Balancing doc page. The servicePort parameter is optional and defaults to 0. Like hostPort, If the value is 0, a random port will be assigned. If a servicePort value is assigned by Marathon then Marathon guarantees that its value is unique across the cluster. The values for random service ports are in the range [local_port_min, local_port_max] where local_port_min and local_port_max are command line options with default values of 10000 and 20000, respectively.",
                    "maximum": 65535,
                    "minimum": 0
                  }
                }
              }
            },
            "privileged": {
              "type": "boolean",
              "description": "Run this docker image in privileged mode."
            }
          },
          "required": [
            "image"
          ],
          "type": "object"
        },
        "appc": {
          "additionalProperties": false,
          "properties": {
            "image": {
              "type": "string",
              "minLength": 1,
              "description": "The name of the AppC image to use."
            },
            "id": {
              "type": "string",
              "minLength": 7,
              "description": "An image ID is a string of the format 'hash-value', where 'hash' is the hash algorithm used and 'value' is the hex-encoded digest. Currently the only permitted hash algorithm is sha512."
            },
            "labels": {
              "type": "object",
              "description": "Optional labels. Suggested labels: 'version', 'os', and 'arch'.",
              "additionalProperties": {
                "type": "string"
              }
            },
            "forcePullImage": {
              "type": "boolean",
              "description": "The container will be pulled, regardless if it is already available on the local system."
            }
          },
          "required": [ "image" ],
          "type": "object"
        },
        "type": {
          "type": "string",
          "description": "Container engine type. Supported engine types at the moment are DOCKER and MESOS.",
          "enum": ["MESOS", "DOCKER"]
        },
        "volumes": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "containerPath": {
                "type": "string",
                "description": "The path of the volume in the container",
                "minLength": 1
              },
              "hostPath": {
                "type": "string",
                "description": "The path of the volume on the host",
                "minLength": 1
              },
              "persistent": {
                "additionalProperties": false,
                "properties": {
                  "size": {
                    "type": "integer",
                    "description": "The size of the persistent volume in MiB",
                    "minimum": 0
                  }
                },
                "type": "object"
              },
              "external": {
                "additionalProperties": false,
                "properties": {
                  "size": {
                    "type": "integer",
                    "description": "The size of the external volume in MiB",
                    "minimum": 0
                  },
                  "name": {
                    "type": "string",
                    "description": "The name of the volume"
                  },
                  "provider": {
                    "type": "string",
                    "description": "The name of the volume provider"
                  },
                  "options": {
                    "type": "object",
                    "description": "Provider-specific volume configuration options"
                  }
                },
                "type": "object"
              },
              "mode": {
                "type": "string",
                "description": "Possible values are RO for ReadOnly and RW for Read/Write",
                "enum": ["RO", "RW"]
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "cpus": {
      "type": "number",
      "description": "The number of CPU shares this application needs per instance. This number does not have to be integer, but can be a fraction.",
      "minimum": 0
    },
    "dependencies": {
      "type": "array",
      "description": "A list of services upon which this application depends. An order is derived from the dependencies for performing start/stop and upgrade of the application. For example, an application /a relies on the services /b which itself relies on /c. To start all 3 applications, first /c is started than /b than /a.",
      "items": {
        "$ref": "#/definitions/pathType"
      }
    },
    "disk": {
      "type": "number",
      "description": "How much disk space in MB is needed for this application. This number does not have to be an integer, but can be a fraction.",
      "minimum": 0
    },
    "env": {
      "patternProperties": {
        ".*": {
          "oneOf": [
            { "type": "string" },
            {
              "type": "object",
              "description": "An environment variable set to a secret.",
              "properties": {
                "secret": {
                  "type": "string",
                  "description": "The key of the secret to be used as a value.",
                  "minLength": 1
                }
              },
              "required": [ "secret" ],
              "additionalProperties": false
            }
          ]
        }
      },
      "type": "object"
    },
    "executor": {
      "type": "string",
      "description": "The executor to use to launch this application. Different executors are available. The simplest one (and the default if none is given) is //cmd, which takes the cmd and executes that on the shell level.",
      "pattern": "^(|\\/\\/cmd|\\/?[^\\/]+(\\/[^\\/]+)*)$"
    },
    "fetch": {
      "type": "array",
      "description": "Provided URIs are passed to Mesos fetcher module and resolved in runtime.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "uri": {
            "type": "string",
            "description": "URI to be fetched by Mesos fetcher module"
          },
          "executable": {
            "type": "boolean",
            "description": "Set fetched artifact as executable"
          },
          "extract": {
            "type": "boolean",
            "description": "Extract fetched artifact if supported by Mesos fetcher module"
          },
          "cache": {
            "type": "boolean",
            "description": "Cache fetched artifact if supported by Mesos fetcher module"
          },
          "outputFile": {
            "type": "string",
            "description": "Rename fetched artifact with the given name"
          }
        },
        "required": [ "uri" ]
      }
    },
    "healthChecks": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "command": {
            "type": "object",
            "items": {
              "additionalProperties": false,
              "properties": {
                "value": {
                  "type": "string",
                  "description": "The health check command to execute."
                }
              }
            }
          },
          "gracePeriodSeconds": {
            "type": "integer",
            "description": "Health check failures are ignored within this number of seconds of the task being started or until the task becomes healthy for the first time.",
            "minimum": 0
          },
          "ignoreHttp1xx": {
            "type": "boolean",
            "description": "Ignore HTTP 1xx responses."
          },
          "intervalSeconds": {
            "type": "integer",
            "description": "Number of seconds to wait between health checks.",
            "minimum": 0
          },
          "maxConsecutiveFailures": {
            "type": "integer",
            "description": "Number of consecutive health check failures after which the unhealthy task should be killed.",
            "minimum": 0
          },
          "path": {
            "type": "string",
            "description": "Path to endpoint exposed by the task that will provide health status. Example: /path/to/health. Note: only used if protocol == HTTP[S]."
          },
          "port": {
            "type": "integer",
            "description": "The specific port to connect to. In case of dynamic ports, see portIndex.",
            "maximum": 65535,
            "minimum": 0
          },
          "portIndex": {
            "type": "integer",
            "description": "Index in this app's ports array to be used for health requests. An index is used so the app can use random ports, like [0, 0, 0] for example, and tasks could be started with port environment variables like $PORT1.",
            "minimum": 0
          },
          "protocol": {
            "type": "string",
            "description": "Protocol of the requests to be performed. One of HTTP, HTTPS, TCP or COMMAND.",
            "enum": ["HTTP", "HTTPS", "TCP", "COMMAND"]
          },
          "timeoutSeconds": {
            "type": "integer",
            "description": "Number of seconds after which a health check is considered a failure regardless of the response.",
            "minimum": 0
          }
        }
      },
      "type": "array"
    },
    "id": {
      "$ref": "#/definitions/pathType",
      "description": "Unique identifier for the app consisting of a series of names separated by slashes. Each name must be at least 1 character and may only contain digits (`0-9`), dashes (`-`), dots (`.`), and lowercase letters (`a-z`). The name may not begin or end with a dash."
    },
    "instances": {
      "type": "integer",
      "description": "The number of instances of this application to start. Please note: this number can be changed any time as needed to scale the application.",
      "minimum": 0
    },
    "labels": {
      "type": "object",
      "description": "Attaching metadata to apps can be useful to expose additional information to other services, so we added the ability to place labels on apps (for example, you could label apps staging and production to mark services by their position in the pipeline).",
      "additionalProperties": {
        "type": "string"
      }
    },
    "maxLaunchDelaySeconds": {
      "type": "integer",
      "description": "Configures exponential backoff behavior when launching potentially sick apps. This prevents sandboxes associated with consecutively failing tasks from filling up the hard disk on Mesos slaves. The backoff period is multiplied by the factor for each consecutive failure until it reaches maxLaunchDelaySeconds. This applies also to tasks that are killed due to failing too many health checks.",
      "minimum": 0
    },
    "mem": {
      "type": "number",
      "description": "The amount of memory in MB that is needed for the application per instance.",
      "minimum": 0
    },
    "gpus": {
     "type": "integer",
     "description": "The amount of GPU cores that is needed for the application per instance.",
     "minimum": 0
    },
    "ipAddress": {
      "type": "object",
      "description": "If an application definition includes the 'ipAddress' field, then Marathon will request a per-task IP from Mesos. A separate ports/portMappings configuration is then disallowed.",
      "properties": {
        "discovery": {
          "type": "object",
          "description": "Information useful for service discovery.",
          "properties": {
            "ports": {
              "type": "array",
              "description": "Array of objects describing the ports exposed by each task.",
              "items": {
                "type": "object",
                "description": "Port",
                "properties": {
                  "number": {
                    "maximum": 65535,
                    "minimum": 0,
                    "type": "integer",
                    "description": "The port number."
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of the port.",
                    "pattern": "^[a-z][a-z0-9-]*$"
                  },
                  "protocol": {
                    "enum": ["tcp", "udp"],
                    "description": "Protocol of the port (one of ['tcp', 'udp'])."
                  }
                }
              }
            }
          }
        },
        "groups": {
          "type": "array",
          "description": "Array of network groups. One IP address can belong to zero or more network groups. The idea is that containers can only reach containers with which they share at least one network group.",
          "items": {
            "type": "string",
            "description": "The name of the network group."
          }
        },
        "labels": {
          "type": "object",
          "description": "Key value pair for meta data on that network interface.",
          "properties": {},
          "additionalProperties": true
        },
        "networkName": {
          "type": "string",
          "description": "If present, declares the name of the network that the container should join. In practice it is up to the IPAM to decide how to interpret this field."
        }
      }
    },
    "ports": {
      "type": "array",
      "description": "An array of required port resources on the agent host. The number of items in the array determines how many dynamic ports are allocated for every task. For every port that is zero, a globally unique (cluster-wide) port is assigned and provided as part of the app definition to be used in load balancing definitions.",
      "items": {
        "maximum": 65535,
        "minimum": 0,
        "type": "integer"
      }
    },
    "portDefinitions": {
      "type": "array",
      "description": "An array of required port resources on the agent host. The number of items in the array determines how many dynamic ports are allocated for every task. For every port definition with port number zero, a globally unique (cluster-wide) service port is assigned and provided as part of the app definition to be used in load balancing definitions.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "port": {
            "type": "integer",
            "description": "if requirePorts is set to true, then this port number will be used on the agent host Otherwise if the requirePorts is set to false and this port number is not zero, then it will be used as a service port and a dynamic port will be used on the agent host. If it is set to zero, a dynamic port will be used on the host and a unique service port will be assigned by Marathon.",
            "maximum": 65535,
            "minimum": 0
          },
          "labels": {
            "type": "object",
            "description": "This can be used to add metadata to be interpreted by external applications such as firewalls.",
            "additionalProperties": {
              "type": "string"
            }
          },
          "name": {
            "type": "string",
            "description": "Name of the service hosted on this port. If provided, it must be unique over all port definitions.",
            "pattern": "^[a-z][a-z0-9-]*$"
          },
          "protocol": {
            "type": "string",
            "enum": ["tcp", "udp"],
            "description": "Protocol of the port (one of ['tcp', 'udp']). Defaults to 'tcp'."
          }
        }
      }
    },
    "readinessChecks": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "Query these readiness checks to determine if a task is ready to serve requests.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name used to identify this readiness check."
          },
          "protocol": {
            "type": "string",
            "description": "Protocol of the requests to be performed. One of HTTP, HTTPS.",
            "enum": ["HTTP", "HTTPS"]
          },
          "path": {
            "type": "string",
            "description": "Path to endpoint exposed by the task that will provide readiness status. Example: /path/to/health."
          },
          "portName": {
            "type": "string",
            "description": "Name of the port to query as described in the portDefinitions. Example: http-api."
          },
          "intervalSeconds": {
            "type": "integer",
            "description": "Number of seconds to wait between readiness checks. Defaults to 30 seconds",
            "minimum": 0
          },
          "timeoutSeconds": {
            "type": "integer",
            "description": "Number of seconds after which a health check is considered a failure regardless of the response. Must be smaller than intervalSeconds. Defaults to 10 seconds.",
            "minimum": 0
          },
          "httpStatusCodesForReady": {
            "items": {
              "type": "integer",
              "minimum": 100,
              "maximum": 999
            },
            "description": "The HTTP(s) status code to treat as 'ready'.",
            "type": "array"
          },
          "preserveLastResponse": {
            "type": "boolean",
            "description": "If and only if true, preserve the last readiness check responses and expose them in the API as part of a deployment.."
          }
        }
      },
      "type": "array"
    },
    "residency": {
      "type": "object",
      "description": "When using local persistent volumes that pin tasks onto agents, these values define how Marathon handles terminal states of these tasks.",
      "properties": {
        "relaunchEscalationTimeoutSeconds": {
          "type": "integer",
          "description": "When a task using persistent local volumes cannot be restarted on the agent it's been pinned to, Marathon will try to launch this task on another node after this timeout. Defaults to 3600 (one hour).",
          "minimum": 0,
          "additionalProperties": false
        },
        "taskLostBehavior": {
          "type": "string",
          "description": "When Marathon receives a TASK_LOST status update indicating that the agent running the task is gone, this property defines whether Marathon will launch the task on another node or not. Defaults to WAIT_FOREVER",
          "enum": ["WAIT_FOREVER", "RELAUNCH_AFTER_TIMEOUT"],
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "requirePorts": {
      "type": "boolean",
      "description": "Normally, the host ports of your tasks are automatically assigned. This corresponds to the requirePorts value false which is the default. If you need more control and want to specify your host ports in advance, you can set requirePorts to true. This way the ports you have specified are used as host ports. That also means that Marathon can schedule the associated tasks only on hosts that have the specified ports available."
    },
    "secrets": {
      "type": "object",
      "description": "A map with named secret declarations. The key is used to reference the values from other places in the app definition.",
      "patternProperties": {
        ".*": {
          "type": "object",
          "description": "A secret declaration.",
          "properties": {
            "source": {
              "type": "string",
              "description": "The source of the secret's value. The format depends on the secret store used by Mesos.",
              "minLength": 1
            }
          },
          "required": [ "source" ],
          "additionalProperties": false
        }
      }
    },
    "storeUrls": {
      "type": "array",
      "description": "URL's that have to be resolved and put into the artifact store, before the task will be started.",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "taskKillGracePeriodSeconds": {
      "type": "integer",
      "description": "Configures the number of seconds between escalating from SIGTERM to SIGKILL when signalling tasks to terminate. Using this grace period, tasks should perform orderly shut down immediately upon receiving SIGTERM.",
      "minimum": 0
    },
    "upgradeStrategy": {
      "type": "object",
      "description": "During an upgrade all instances of an application get replaced by a new version. The upgradeStrategy controls how Marathon stops old versions and launches new versions.",
      "additionalProperties": false,
      "properties": {
        "maximumOverCapacity": {
          "type": "number",
          "description": "A number between 0 and 1 which is multiplied with the instance count. This is the maximum number of additional instances launched at any point of time during the upgrade process.",
          "maximum": 1.0,
          "minimum": 0.0
        },
        "minimumHealthCapacity": {
          "type": "number",
          "description": "A number between 0 and 1 that is multiplied with the instance count. This is the minimum number of healthy nodes that do not sacrifice overall application purpose. Marathon will make sure, during the upgrade process, that at any point of time this number of healthy instances are up.",
          "maximum": 1.0,
          "minimum": 0.0
        }
      }
    },
    "uris": {
      "type": "array",
      "description": "URIs defined here are resolved, before the application gets started. If the application has external dependencies, they should be defined here.",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "user": {
      "type": "string",
      "description": "The user to use to run the tasks on the agent."
    },
    "version": {
      "type": "string",
      "description": "The version of this definition.",
      "format": "date-time"
    },
    "versionInfo": {
      "type": "object",
      "description": "Detailed version information.",
      "additionalProperties": false,
      "properties": {
        "lastScalingAt": {
          "type": "string",
          "description": "Contains the time stamp of the last change to this app which was not simply a scaling or a restarting configuration.",
          "format": "date-time"
        },
        "lastConfigChangeAt": {
          "type": "string",
          "description": "Contains the time stamp of the last change including changes like scaling or restarting the app. Since our versions are time based, this is currently equal to version.",
          "format": "date-time"
        }
      }
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Example:

{
  "id": "/foo",
  "instances": 2,
  "cmd": "sleep 1000",
  "cpus": 0.1,
  "disk": 0,
  "mem": 16,
  "acceptedResourceRoles": [
    "mesos_role"
  ],
  "args": [
    "sleep",
    "100"
  ],
  "backoffFactor": 1.15,
  "backoffSeconds": 1,
  "constraints": [
    [
      "hostname",
      "LIKE",
      "srv2.*"
    ]
  ],
  "container": {
    "docker": {
      "forcePullImage": false,
      "image": "mesosphere:marathon/latest",
      "network": "BRIDGE",
      "parameters": [
        {
          "key": "name",
          "value": "kdc"
        }
      ],
      "portMappings": [
        {
          "containerPort": 80,
          "hostPort": 0,
          "protocol": "tcp",
          "servicePort": 10019,
          "name": "http",
          "labels": { "vip": "192.168.0.1:80" }
        }
      ],
      "privileged": false
    },
    "type": "DOCKER",
    "volumes": [
      {
        "containerPath": "/docker_storage",
        "hostPath": "/hdd/tools/docker/registry",
        "mode": "RW"
      }
    ]
  },
  "dependencies": [
    "/prod/group"
  ],
  "env": {
    "XPS1": "Test",
    "XPS2": "Rest",
    "PASSWORD": { "secret": "/db/password" }
  },
  "executor": "",
  "healthChecks": [
    {
      "gracePeriodSeconds": 300,
      "ignoreHttp1xx": false,
      "intervalSeconds": 20,
      "maxConsecutiveFailures": 3,
      "path": "/",
      "portIndex": 0,
      "protocol": "HTTP",
      "timeoutSeconds": 20
    }
  ],
  "readinessChecks": [
    {
      "name": "myReadyCheck",
      "protocol": "HTTP",
      "path": "/v1/plan",
      "portName": "http",
      "intervalSeconds": 10,
      "timeoutSeconds": 3,
      "httpStatusCodesForReady": [ 200 ],
      "preserveLastResponse": true
    }
  ],
  "labels": {
    "owner": "zeus",
    "note": "Away from olympus"
  },
  "maxLaunchDelaySeconds": 3600,
  "ipAddress": {
    "discovery": {
      "ports": [
        {
          "number": 8080,
          "name": "rest_endpoint",
          "protocol": "tcp"
        }
      ]
    },
    "groups": [
      "dev"
    ],
    "labels": {
      "environment": "dev"
    }
  },
  "portDefinitions": [
    {
      "port": 0,
      "protocol": "tcp",
      "name": "http",
      "labels": { "vip": "192.168.0.1:80" }
    }
  ],
  "requirePorts": false,
  "upgradeStrategy": {
    "maximumOverCapacity": 1,
    "minimumHealthCapacity": 1
  },
  "fetch": [
    { "uri": "https://foo.com/setup.py" },
    { "uri": "https://foo.com/archive.zip", "executable": false, "extract": true, "cache": true, "outputFile": "newname.zip" }
  ],
  "user": "root",
  "secrets": {
    "secret1": { "source": "/db/password" },
    "secret3": { "source": "/foo2" }
  },
  "taskKillGracePeriodSeconds": 30
}

URI Parameters

• app_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

URI Parameters

• app_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

URI Parameters

• app_id: required (string)

URI Parameters

• app_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

• host: (string)

  all tasks of that application on the supplied slave are killed

• scale: (boolean - default: false)

  If scale=true is specified, then the application is scaled down by the number of killed tasks. Only possible if wipe=false or not specified.

• wipe: (boolean - default: false)

  If wipe=true is specified and the app uses local persistent volumes, associated dynamic reservations will be unreserved, and persistent volumes will be destroyed. Only possible if scale=false or not specified.

URI Parameters

• app_id: required (string)
• task_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

• scale: (boolean - default: false)

  If scale=true is specified, then the application is scaled down by the number of killed tasks. Only possible if wipe=false or not specified.

• wipe: (boolean - default: false)

  If wipe=true is specified and the app uses local persistent volumes, associated dynamic reservations will be unreserved, and persistent volumes will be destroyed. Only possible if scale=false or not specified.

URI Parameters

• app_id: required (string)

URI Parameters

• app_id: required (string)
• version: required (string)

HTTP status code 200

The list of all running deployments.

Body

Type: application/json

Example:

[
  {
    "id": "97c136bf-5a28-4821-9d94-480d9fbb01c8",
    "version": "2015-09-30T09:09:17.614Z",
    "affectedApps": [
      "/foo"
    ],
    "steps": [
      {
        "actions": [
          {
            "action": "StartApplication",
            "app": "/foo"
          }
        ]
      },
      {
        "actions": [
          {
            "action": "ScaleApplication",
            "app": "/foo"
          }
        ]
      }
    ],
    "currentActions": [
      {
        "action": "ScaleApplication",
        "app": "/foo",
        "readinessCheckResults": {
          "/foo": [
            {
              "taskId": "foo.c9de6033",
              "lastResponse": {
                "body": "{}",
                "contentType": "application/json",
                "status": 500
              },
              "name": "myReadyCheck",
              "ready": false
            }
          ]
        }
      }
    ],
    "currentStep": 2,
    "totalSteps": 2
  }
]

HTTP status code 401

Unauthorized. Authentication is enabled and you did not provide enough or wrong information to authenticate that request.

Body

Type: application/json

Example:

{ "message": "Invalid username or password." }

HTTP status code 403

Forbidden. Authorization is granted but the identity provided does not have sufficient access rights to do that action.

Body

Type: application/json

Example:

{ "message": "Not Authorized to perform this action!" }

URI Parameters

• deployment_id: required (string)

Query Parameters

• force: (boolean - default: false)

  If set to false (the default) then the deployment is canceled and a new deployment is created to revert the changes of this deployment. Without concurrent deployments, this restores the configuration before this deployment. If set to true, then the deployment is still canceled but no rollback deployment is created.

Query Parameters

• embed: (one of group.groups, group.apps, group.apps.tasks, group.apps.count, group.apps.deployments, group.apps.lastTaskFailure, group.apps.failures, group.apps.taskStats - repeat: true)

  Embeds nested resources that match the supplied path. You can specify this parameter multiple times with different values. Unknown embed parameters are ignored. If you omit this parameter, it defaults to group.groups, group.apps

  • group.groups embed all child groups of each group
    
  • group.apps embed all apps of each group
    
  • group.apps.tasks embed all tasks of each application
    
  • group.apps.counts embed all task counts (tasksStaged, tasksRunning, tasksHealthy, tasksUnhealthy)
    
  • group.apps.deployments embed all deployment identifier, if the related app currently is in deployment.
  • group.apps.readiness embed all readiness check results
  • group.apps.lastTaskFailure embeds the lastTaskFailure for the application if there is one.
  • group.apps.taskStats exposes task statistics in the JSON.

  Example:

  group.apps

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/schema#",
  "id": "https://raw.githubusercontent.com/mesosphere/marathon/master/docs/docs/rest-api/public/api/v2/schema/Group.json",
  "additionalProperties": false,
  "definitions": {
    "pathType": {
      "type": "string",
      "pattern": "^(\\/?((\\.{2})|([a-z0-9][a-z0-9\\-.]*[a-z0-9]+)|([a-z0-9]*))($|\\/))+$",
      "minLength": 1
    }
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "$ref": "#/definitions/pathType",
      "description": "Unique identifier for the app consisting of a series of names separated by slashes. Each name must be at least 1 character and may only contain digits (`0-9`), dashes (`-`), dots (`.`), and lowercase letters (`a-z`). The name may not begin or end with a dash."
    },
    "apps": {
      "type": "array",
      "description": "The list of AppDefinitions in this group. See AppDefinition.json for the schema.",
      "items": {
        "$ref": "./AppDefinition.json"
      }
    },
    "groups": {
      "type": "array",
      "description": "Groups can build a tree. Each group can contain sub-groups. The sub-groups are defined here.",
      "items": {
        "$ref": "#"
      }
    },
    "dependencies": {
      "type": "array",
      "description": "A list of services upon which this application depends. An order is derived from the dependencies for performing start/stop and upgrade of the application. For example, an application /a relies on the services /b which itself relies on /c. To start all 3 applications, first /c is started than /b than /a.",
      "items": {
        "$ref": "#/definitions/pathType"
      }
    },
    "version": {
      "type": "string",
      "description": "The version of this definition.",
      "format": "date-time"
    }
  },
  "required": [
    "id"
  ]
}

Example:

{
  "id": "/",
  "apps": [],
  "groups": [
    {
      "id": "/tools",
      "apps": [
        {
          "id": "/tools/oauth-server",
          "instances": 2,
          "cpus": 1,
          "mem": 1024,
          "disk": 0,
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            1980
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [],
            "docker": {
              "image": "docker-registry/oauth_server:6d7d463cb8b1517002080a81cf23f9cf7b7fc774",
              "network": "HOST",
              "privileged": false,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [
            {
              "path": "/",
              "protocol": "HTTP",
              "portIndex": 0,
              "gracePeriodSeconds": 300,
              "intervalSeconds": 20,
              "timeoutSeconds": 20,
              "maxConsecutiveFailures": 3,
              "ignoreHttp1xx": false
            }
          ],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-09-28T19:47:37.681Z",
          "versionInfo": {
            "lastScalingAt": "2015-09-28T19:47:37.681Z",
            "lastConfigChangeAt": "2015-09-28T19:47:37.681Z"
          }
        },
        {
          "id": "/tools/datadog-agent",
          "instances": 5,
          "cpus": 1,
          "mem": 512,
          "disk": 0,
          "executor": "",
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            10018
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [
              {
                "containerPath": "/var/run/docker.sock",
                "hostPath": "/var/run/docker.sock",
                "mode": "RW"
              },
              {
                "containerPath": "/host/proc/mounts",
                "hostPath": "/proc/mounts",
                "mode": "RO"
              },
              {
                "containerPath": "/host/sys/fs/cgroup",
                "hostPath": "/sys/fs/cgroup/",
                "mode": "RO"
              }
            ],
            "docker": {
              "image": "datadog/docker-dd-agent:latest",
              "network": "HOST",
              "privileged": true,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-08-26T22:33:24.225Z",
          "versionInfo": {
            "lastScalingAt": "2015-08-26T22:33:24.225Z",
            "lastConfigChangeAt": "2015-05-19T13:59:18.899Z"
          }
        }
      ],
      "groups": [
        {
          "id": "/tools/log",
          "apps": [],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        },
        {
          "id": "/tools/docker",
          "apps": [
            {
              "id": "/tools/docker/registry",
              "instances": 1,
              "cpus": 0.5,
              "mem": 4096,
              "disk": 0,
              "executor": "",
              "constraints": [],
              "uris": [],
              "storeUrls": [],
              "ports": [
                5000
              ],
              "requirePorts": false,
              "backoffSeconds": 1,
              "backoffFactor": 1.15,
              "maxLaunchDelaySeconds": 3600,
              "container": {
                "type": "DOCKER",
                "volumes": [
                  {
                    "containerPath": "/docker_storage",
                    "hostPath": "/hdd/tools/docker/registry",
                    "mode": "RW"
                  }
                ],
                "docker": {
                  "image": "registry",
                  "network": "BRIDGE",
                  "portMappings": [
                    {
                      "containerPort": 5000,
                      "hostPort": 0,
                      "servicePort": 5000,
                      "protocol": "tcp"
                    }
                  ],
                  "privileged": false,
                  "parameters": [],
                  "forcePullImage": false
                }
              },
              "healthChecks": [],
              "dependencies": [],
              "upgradeStrategy": {
                "minimumHealthCapacity": 1,
                "maximumOverCapacity": 1
              },
              "version": "2015-08-19T21:26:47.616Z",
              "versionInfo": {
                "lastScalingAt": "2015-08-19T21:26:47.616Z",
                "lastConfigChangeAt": "2015-08-19T21:00:54.621Z"
              }
            }
          ],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        }
      ],
      "dependencies": [],
      "version": "2015-09-17T10:38:20.875Z"
    }
  ],
  "dependencies": [],
  "version": "2015-09-17T10:38:20.875Z"
}

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/schema#",
  "id": "https://raw.githubusercontent.com/mesosphere/marathon/master/docs/docs/rest-api/public/api/v2/schema/Group.json",
  "additionalProperties": false,
  "definitions": {
    "pathType": {
      "type": "string",
      "pattern": "^(\\/?((\\.{2})|([a-z0-9][a-z0-9\\-.]*[a-z0-9]+)|([a-z0-9]*))($|\\/))+$",
      "minLength": 1
    }
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "$ref": "#/definitions/pathType",
      "description": "Unique identifier for the app consisting of a series of names separated by slashes. Each name must be at least 1 character and may only contain digits (`0-9`), dashes (`-`), dots (`.`), and lowercase letters (`a-z`). The name may not begin or end with a dash."
    },
    "apps": {
      "type": "array",
      "description": "The list of AppDefinitions in this group. See AppDefinition.json for the schema.",
      "items": {
        "$ref": "./AppDefinition.json"
      }
    },
    "groups": {
      "type": "array",
      "description": "Groups can build a tree. Each group can contain sub-groups. The sub-groups are defined here.",
      "items": {
        "$ref": "#"
      }
    },
    "dependencies": {
      "type": "array",
      "description": "A list of services upon which this application depends. An order is derived from the dependencies for performing start/stop and upgrade of the application. For example, an application /a relies on the services /b which itself relies on /c. To start all 3 applications, first /c is started than /b than /a.",
      "items": {
        "$ref": "#/definitions/pathType"
      }
    },
    "version": {
      "type": "string",
      "description": "The version of this definition.",
      "format": "date-time"
    }
  },
  "required": [
    "id"
  ]
}

Example:

{
  "id": "/",
  "apps": [],
  "groups": [
    {
      "id": "/tools",
      "apps": [
        {
          "id": "/tools/oauth-server",
          "instances": 2,
          "cpus": 1,
          "mem": 1024,
          "disk": 0,
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            1980
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [],
            "docker": {
              "image": "docker-registry/oauth_server:6d7d463cb8b1517002080a81cf23f9cf7b7fc774",
              "network": "HOST",
              "privileged": false,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [
            {
              "path": "/",
              "protocol": "HTTP",
              "portIndex": 0,
              "gracePeriodSeconds": 300,
              "intervalSeconds": 20,
              "timeoutSeconds": 20,
              "maxConsecutiveFailures": 3,
              "ignoreHttp1xx": false
            }
          ],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-09-28T19:47:37.681Z",
          "versionInfo": {
            "lastScalingAt": "2015-09-28T19:47:37.681Z",
            "lastConfigChangeAt": "2015-09-28T19:47:37.681Z"
          }
        },
        {
          "id": "/tools/datadog-agent",
          "instances": 5,
          "cpus": 1,
          "mem": 512,
          "disk": 0,
          "executor": "",
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            10018
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [
              {
                "containerPath": "/var/run/docker.sock",
                "hostPath": "/var/run/docker.sock",
                "mode": "RW"
              },
              {
                "containerPath": "/host/proc/mounts",
                "hostPath": "/proc/mounts",
                "mode": "RO"
              },
              {
                "containerPath": "/host/sys/fs/cgroup",
                "hostPath": "/sys/fs/cgroup/",
                "mode": "RO"
              }
            ],
            "docker": {
              "image": "datadog/docker-dd-agent:latest",
              "network": "HOST",
              "privileged": true,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-08-26T22:33:24.225Z",
          "versionInfo": {
            "lastScalingAt": "2015-08-26T22:33:24.225Z",
            "lastConfigChangeAt": "2015-05-19T13:59:18.899Z"
          }
        }
      ],
      "groups": [
        {
          "id": "/tools/log",
          "apps": [],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        },
        {
          "id": "/tools/docker",
          "apps": [
            {
              "id": "/tools/docker/registry",
              "instances": 1,
              "cpus": 0.5,
              "mem": 4096,
              "disk": 0,
              "executor": "",
              "constraints": [],
              "uris": [],
              "storeUrls": [],
              "ports": [
                5000
              ],
              "requirePorts": false,
              "backoffSeconds": 1,
              "backoffFactor": 1.15,
              "maxLaunchDelaySeconds": 3600,
              "container": {
                "type": "DOCKER",
                "volumes": [
                  {
                    "containerPath": "/docker_storage",
                    "hostPath": "/hdd/tools/docker/registry",
                    "mode": "RW"
                  }
                ],
                "docker": {
                  "image": "registry",
                  "network": "BRIDGE",
                  "portMappings": [
                    {
                      "containerPort": 5000,
                      "hostPort": 0,
                      "servicePort": 5000,
                      "protocol": "tcp"
                    }
                  ],
                  "privileged": false,
                  "parameters": [],
                  "forcePullImage": false
                }
              },
              "healthChecks": [],
              "dependencies": [],
              "upgradeStrategy": {
                "minimumHealthCapacity": 1,
                "maximumOverCapacity": 1
              },
              "version": "2015-08-19T21:26:47.616Z",
              "versionInfo": {
                "lastScalingAt": "2015-08-19T21:26:47.616Z",
                "lastConfigChangeAt": "2015-08-19T21:00:54.621Z"
              }
            }
          ],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        }
      ],
      "dependencies": [],
      "version": "2015-09-17T10:38:20.875Z"
    }
  ],
  "dependencies": [],
  "version": "2015-09-17T10:38:20.875Z"
}

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

HTTP status code 200

List all available versions of that group.

Body

Type: application/json

Example:

[ "2015-09-25T15:13:48.343Z", "2015-09-11T11:11:22.692Z", "2015-09-11T10:47:21.241Z" ]

HTTP status code 401

Unauthorized. Authentication is enabled and you did not provide enough or wrong information to authenticate that request.

Body

Type: application/json

Example:

{ "message": "Invalid username or password." }

HTTP status code 403

Forbidden. Authorization is granted but the identity provided does not have sufficient access rights to do that action.

Body

Type: application/json

Example:

{ "message": "Not Authorized to perform this action!" }

URI Parameters

• group_id: required (string)

Query Parameters

• embed: (one of group.groups, group.apps, group.apps.tasks, group.apps.count, group.apps.deployments, group.apps.lastTaskFailure, group.apps.failures, group.apps.taskStats - repeat: true)

  Embeds nested resources that match the supplied path. You can specify this parameter multiple times with different values. Unknown embed parameters are ignored. If you omit this parameter, it defaults to group.groups, group.apps

  • group.groups embed all child groups of each group
    
  • group.apps embed all apps of each group
    
  • group.apps.tasks embed all tasks of each application
    
  • group.apps.counts embed all task counts (tasksStaged, tasksRunning, tasksHealthy, tasksUnhealthy)
    
  • group.apps.deployments embed all deployment identifier, if the related app currently is in deployment.
  • group.apps.readiness embed all readiness check results
  • group.apps.lastTaskFailure embeds the lastTaskFailure for the application if there is one.
  • group.apps.taskStats exposes task statistics in the JSON.

  Example:

  group.apps

URI Parameters

• group_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/schema#",
  "id": "https://raw.githubusercontent.com/mesosphere/marathon/master/docs/docs/rest-api/public/api/v2/schema/Group.json",
  "additionalProperties": false,
  "definitions": {
    "pathType": {
      "type": "string",
      "pattern": "^(\\/?((\\.{2})|([a-z0-9][a-z0-9\\-.]*[a-z0-9]+)|([a-z0-9]*))($|\\/))+$",
      "minLength": 1
    }
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "$ref": "#/definitions/pathType",
      "description": "Unique identifier for the app consisting of a series of names separated by slashes. Each name must be at least 1 character and may only contain digits (`0-9`), dashes (`-`), dots (`.`), and lowercase letters (`a-z`). The name may not begin or end with a dash."
    },
    "apps": {
      "type": "array",
      "description": "The list of AppDefinitions in this group. See AppDefinition.json for the schema.",
      "items": {
        "$ref": "./AppDefinition.json"
      }
    },
    "groups": {
      "type": "array",
      "description": "Groups can build a tree. Each group can contain sub-groups. The sub-groups are defined here.",
      "items": {
        "$ref": "#"
      }
    },
    "dependencies": {
      "type": "array",
      "description": "A list of services upon which this application depends. An order is derived from the dependencies for performing start/stop and upgrade of the application. For example, an application /a relies on the services /b which itself relies on /c. To start all 3 applications, first /c is started than /b than /a.",
      "items": {
        "$ref": "#/definitions/pathType"
      }
    },
    "version": {
      "type": "string",
      "description": "The version of this definition.",
      "format": "date-time"
    }
  },
  "required": [
    "id"
  ]
}

Example:

{
  "id": "/",
  "apps": [],
  "groups": [
    {
      "id": "/tools",
      "apps": [
        {
          "id": "/tools/oauth-server",
          "instances": 2,
          "cpus": 1,
          "mem": 1024,
          "disk": 0,
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            1980
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [],
            "docker": {
              "image": "docker-registry/oauth_server:6d7d463cb8b1517002080a81cf23f9cf7b7fc774",
              "network": "HOST",
              "privileged": false,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [
            {
              "path": "/",
              "protocol": "HTTP",
              "portIndex": 0,
              "gracePeriodSeconds": 300,
              "intervalSeconds": 20,
              "timeoutSeconds": 20,
              "maxConsecutiveFailures": 3,
              "ignoreHttp1xx": false
            }
          ],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-09-28T19:47:37.681Z",
          "versionInfo": {
            "lastScalingAt": "2015-09-28T19:47:37.681Z",
            "lastConfigChangeAt": "2015-09-28T19:47:37.681Z"
          }
        },
        {
          "id": "/tools/datadog-agent",
          "instances": 5,
          "cpus": 1,
          "mem": 512,
          "disk": 0,
          "executor": "",
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            10018
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [
              {
                "containerPath": "/var/run/docker.sock",
                "hostPath": "/var/run/docker.sock",
                "mode": "RW"
              },
              {
                "containerPath": "/host/proc/mounts",
                "hostPath": "/proc/mounts",
                "mode": "RO"
              },
              {
                "containerPath": "/host/sys/fs/cgroup",
                "hostPath": "/sys/fs/cgroup/",
                "mode": "RO"
              }
            ],
            "docker": {
              "image": "datadog/docker-dd-agent:latest",
              "network": "HOST",
              "privileged": true,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-08-26T22:33:24.225Z",
          "versionInfo": {
            "lastScalingAt": "2015-08-26T22:33:24.225Z",
            "lastConfigChangeAt": "2015-05-19T13:59:18.899Z"
          }
        }
      ],
      "groups": [
        {
          "id": "/tools/log",
          "apps": [],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        },
        {
          "id": "/tools/docker",
          "apps": [
            {
              "id": "/tools/docker/registry",
              "instances": 1,
              "cpus": 0.5,
              "mem": 4096,
              "disk": 0,
              "executor": "",
              "constraints": [],
              "uris": [],
              "storeUrls": [],
              "ports": [
                5000
              ],
              "requirePorts": false,
              "backoffSeconds": 1,
              "backoffFactor": 1.15,
              "maxLaunchDelaySeconds": 3600,
              "container": {
                "type": "DOCKER",
                "volumes": [
                  {
                    "containerPath": "/docker_storage",
                    "hostPath": "/hdd/tools/docker/registry",
                    "mode": "RW"
                  }
                ],
                "docker": {
                  "image": "registry",
                  "network": "BRIDGE",
                  "portMappings": [
                    {
                      "containerPort": 5000,
                      "hostPort": 0,
                      "servicePort": 5000,
                      "protocol": "tcp"
                    }
                  ],
                  "privileged": false,
                  "parameters": [],
                  "forcePullImage": false
                }
              },
              "healthChecks": [],
              "dependencies": [],
              "upgradeStrategy": {
                "minimumHealthCapacity": 1,
                "maximumOverCapacity": 1
              },
              "version": "2015-08-19T21:26:47.616Z",
              "versionInfo": {
                "lastScalingAt": "2015-08-19T21:26:47.616Z",
                "lastConfigChangeAt": "2015-08-19T21:00:54.621Z"
              }
            }
          ],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        }
      ],
      "dependencies": [],
      "version": "2015-09-17T10:38:20.875Z"
    }
  ],
  "dependencies": [],
  "version": "2015-09-17T10:38:20.875Z"
}

URI Parameters

• group_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/schema#",
  "id": "https://raw.githubusercontent.com/mesosphere/marathon/master/docs/docs/rest-api/public/api/v2/schema/Group.json",
  "additionalProperties": false,
  "definitions": {
    "pathType": {
      "type": "string",
      "pattern": "^(\\/?((\\.{2})|([a-z0-9][a-z0-9\\-.]*[a-z0-9]+)|([a-z0-9]*))($|\\/))+$",
      "minLength": 1
    }
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "$ref": "#/definitions/pathType",
      "description": "Unique identifier for the app consisting of a series of names separated by slashes. Each name must be at least 1 character and may only contain digits (`0-9`), dashes (`-`), dots (`.`), and lowercase letters (`a-z`). The name may not begin or end with a dash."
    },
    "apps": {
      "type": "array",
      "description": "The list of AppDefinitions in this group. See AppDefinition.json for the schema.",
      "items": {
        "$ref": "./AppDefinition.json"
      }
    },
    "groups": {
      "type": "array",
      "description": "Groups can build a tree. Each group can contain sub-groups. The sub-groups are defined here.",
      "items": {
        "$ref": "#"
      }
    },
    "dependencies": {
      "type": "array",
      "description": "A list of services upon which this application depends. An order is derived from the dependencies for performing start/stop and upgrade of the application. For example, an application /a relies on the services /b which itself relies on /c. To start all 3 applications, first /c is started than /b than /a.",
      "items": {
        "$ref": "#/definitions/pathType"
      }
    },
    "version": {
      "type": "string",
      "description": "The version of this definition.",
      "format": "date-time"
    }
  },
  "required": [
    "id"
  ]
}

Example:

{
  "id": "/",
  "apps": [],
  "groups": [
    {
      "id": "/tools",
      "apps": [
        {
          "id": "/tools/oauth-server",
          "instances": 2,
          "cpus": 1,
          "mem": 1024,
          "disk": 0,
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            1980
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [],
            "docker": {
              "image": "docker-registry/oauth_server:6d7d463cb8b1517002080a81cf23f9cf7b7fc774",
              "network": "HOST",
              "privileged": false,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [
            {
              "path": "/",
              "protocol": "HTTP",
              "portIndex": 0,
              "gracePeriodSeconds": 300,
              "intervalSeconds": 20,
              "timeoutSeconds": 20,
              "maxConsecutiveFailures": 3,
              "ignoreHttp1xx": false
            }
          ],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-09-28T19:47:37.681Z",
          "versionInfo": {
            "lastScalingAt": "2015-09-28T19:47:37.681Z",
            "lastConfigChangeAt": "2015-09-28T19:47:37.681Z"
          }
        },
        {
          "id": "/tools/datadog-agent",
          "instances": 5,
          "cpus": 1,
          "mem": 512,
          "disk": 0,
          "executor": "",
          "constraints": [
            [
              "hostname",
              "UNIQUE"
            ]
          ],
          "uris": [],
          "storeUrls": [],
          "ports": [
            10018
          ],
          "requirePorts": false,
          "backoffSeconds": 1,
          "backoffFactor": 1.15,
          "maxLaunchDelaySeconds": 3600,
          "container": {
            "type": "DOCKER",
            "volumes": [
              {
                "containerPath": "/var/run/docker.sock",
                "hostPath": "/var/run/docker.sock",
                "mode": "RW"
              },
              {
                "containerPath": "/host/proc/mounts",
                "hostPath": "/proc/mounts",
                "mode": "RO"
              },
              {
                "containerPath": "/host/sys/fs/cgroup",
                "hostPath": "/sys/fs/cgroup/",
                "mode": "RO"
              }
            ],
            "docker": {
              "image": "datadog/docker-dd-agent:latest",
              "network": "HOST",
              "privileged": true,
              "parameters": [],
              "forcePullImage": false
            }
          },
          "healthChecks": [],
          "dependencies": [],
          "upgradeStrategy": {
            "minimumHealthCapacity": 0.5,
            "maximumOverCapacity": 0
          },
          "version": "2015-08-26T22:33:24.225Z",
          "versionInfo": {
            "lastScalingAt": "2015-08-26T22:33:24.225Z",
            "lastConfigChangeAt": "2015-05-19T13:59:18.899Z"
          }
        }
      ],
      "groups": [
        {
          "id": "/tools/log",
          "apps": [],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        },
        {
          "id": "/tools/docker",
          "apps": [
            {
              "id": "/tools/docker/registry",
              "instances": 1,
              "cpus": 0.5,
              "mem": 4096,
              "disk": 0,
              "executor": "",
              "constraints": [],
              "uris": [],
              "storeUrls": [],
              "ports": [
                5000
              ],
              "requirePorts": false,
              "backoffSeconds": 1,
              "backoffFactor": 1.15,
              "maxLaunchDelaySeconds": 3600,
              "container": {
                "type": "DOCKER",
                "volumes": [
                  {
                    "containerPath": "/docker_storage",
                    "hostPath": "/hdd/tools/docker/registry",
                    "mode": "RW"
                  }
                ],
                "docker": {
                  "image": "registry",
                  "network": "BRIDGE",
                  "portMappings": [
                    {
                      "containerPort": 5000,
                      "hostPort": 0,
                      "servicePort": 5000,
                      "protocol": "tcp"
                    }
                  ],
                  "privileged": false,
                  "parameters": [],
                  "forcePullImage": false
                }
              },
              "healthChecks": [],
              "dependencies": [],
              "upgradeStrategy": {
                "minimumHealthCapacity": 1,
                "maximumOverCapacity": 1
              },
              "version": "2015-08-19T21:26:47.616Z",
              "versionInfo": {
                "lastScalingAt": "2015-08-19T21:26:47.616Z",
                "lastConfigChangeAt": "2015-08-19T21:00:54.621Z"
              }
            }
          ],
          "groups": [],
          "dependencies": [],
          "version": "2015-09-17T10:38:20.875Z"
        }
      ],
      "dependencies": [],
      "version": "2015-09-17T10:38:20.875Z"
    }
  ],
  "dependencies": [],
  "version": "2015-09-17T10:38:20.875Z"
}

URI Parameters

• group_id: required (string)

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

URI Parameters

• group_id: required (string)

Query Parameters

• status: (one of running, staging - repeat: true)

  Filter the list of tasks by status

Query Parameters

• force: (boolean - default: false)

  Only one deployment can be applied to one application at the same time. If the existing deployment should be canceled by this change, you can set force=true. Caution: setting force=true will cancel the current deployment. This paramter should be used only, if the current deployment is unsuccessful!

• scale: (boolean - default: false)

  If scale=true is specified, then the related application is scaled down by the number of killed tasks. Only possible if wipe=false or not specified.

• wipe: (boolean - default: false)

  If wipe=true is specified and the app uses local persistent volumes, associated dynamic reservations will be unreserved, and persistent volumes will be destroyed. Only possible if scale=false or not specified.

Body

Type: application/json

Example:

{ "ids": [ "task1", "task2" ] }

Body

Type: multipart/form-data

• file: (file)

  The file to upload

URI Parameters

• path: required (string)

Body

Type: multipart/form-data

• file: (file)

  The file to upload

URI Parameters

• path: required (string)

Body

Type: multipart/form-data

• file: (file)

  The file to upload

URI Parameters

• path: required (string)

URI Parameters

• path: required (string)

HTTP status code 200

the list of all tasks waiting to be scheduled.

Body

Type: text/event-stream

Example:

event: event_stream_attached
data: {"remoteAddress":"0:0:0:0:0:0:0:1","eventType":"event_stream_attached","timestamp":"2015-09-30T12:44:30.061Z"}

event: status_update_event
data: {"slaveId":"20150707-153709-218108076-5050-25588-S6","taskId":"foo.0664256e-6771-11e5-94e1-be5b2935a987","taskStatus":"TASK_FAILED","message":"Failed to launch container: Failed to fetch all URIs for container '59d5cd89-091f-4454-940a-d9eb4361c640' with exit status: 256","appId":"/foo","host":"srv5.hw.ca1.mesosphere.com","ports":[31776],"version":"2015-09-30T09:09:17.614Z","eventType":"status_update_event","timestamp":"2015-09-30T12:44:45.681Z"}

event: status_update_event
data: {"slaveId":"20150707-153709-201330860-5050-12052-S0","taskId":"test-app.5dd78972-6771-11e5-94e1-be5b2935a987","taskStatus":"TASK_RUNNING","message":"","appId":"/test-app","host":"srv4.hw.ca1.mesosphere.com","ports":[31182],"version":"2015-09-11T22:11:03.156Z","eventType":"status_update_event","timestamp":"2015-09-30T12:47:11.286Z"}

HTTP status code 405

A request has been made without the correct Accept Header

Body

Type: text/html

Example:

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=ISO-8859-1"/>
<title>Error 405 </title>
</head>
<body>
<h2>HTTP ERROR: 405</h2>
<p>Problem accessing /v2/events. Reason:
<pre>    HTTP method GET is not supported by this URL</pre></p>
<hr /><a href="http://eclipse.org/jetty">Powered by Jetty:// 9.3.z-SNAPSHOT</a><hr/>
</body>
</html>

HTTP status code 200

Return the list of all subscription endpoints

Body

Type: application/json

Example:

{
    "callbackUrls": [
        "http://server123:9090/callback",
        "http://server234:9191/callback"
    ]
}

Query Parameters

• callbackUrl: (string - pattern: ^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$)

  The URL to an endpoint that is able to handle post requests for every event that is send.

Query Parameters

• callbackUrl: (string - pattern: ^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$)

  The URL to an endpoint that is able to handle post requests for every event that is send.

HTTP status code 200

General configuration and runtime information about this Marathon instance.

Body

Type: application/json

Example:

{
  "name": "marathon",
  "version": "0.13.0-SNAPSHOT",
  "elected": true,
  "leader": "wrk.fritz.box:8080",
  "frameworkId": "80ba2050-bf0f-4472-a2f7-2636c4f7b8c8-0000",
  "marathon_config": {
    "master": "127.0.0.1:5050",
    "failover_timeout": 604800,
    "framework_name": "marathon",
    "ha": true,
    "checkpoint": true,
    "local_port_min": 10000,
    "local_port_max": 20000,
    "executor": "//cmd",
    "hostname": "wrk.fritz.box",
    "webui_url": null,
    "mesos_role": null,
    "task_launch_timeout": 300000,
    "reconciliation_initial_delay": 15000,
    "reconciliation_interval": 300000,
    "marathon_store_timeout": 2000,
    "mesos_user": "matthias",
    "leader_proxy_connection_timeout_ms": 5000,
    "leader_proxy_read_timeout_ms": 10000,
    "mesos_leader_ui_url": null
  },
  "zookeeper_config": {
    "zk": "zk://localhost:2181/marathon",
    "zk_timeout": 10000,
    "zk_session_timeout": 1800000,
    "zk_max_versions": 25
  },
  "event_subscriber": null,
  "http_config": {
    "assets_path": null,
    "http_port": 8080,
    "https_port": 8443
  }
}

HTTP status code 200

The host and port of the current leading master.

Body

Type: application/json

Example:

{
    "leader": "marathon.globalcorp.com:8080"
}

HTTP status code 404

If there is no current leader.

Body

Type: application/json

Example:

{
  "message":"There is no leader"
}

HTTP status code 200

The abdication message from the current leader.

Body

Type: application/json

Example:

{
    "message": "Leadership abdicated"
}

HTTP status code 404

If there is no current leader.

Body

Type: application/json

Example:

{
  "message":"There is no leader"
}

HTTP status code 200

The list of all loaded plugins

Body

Type: application/json

Example:

{
    "plugins": [
        {
            "id": "webjar",
            "implementation": "mesosphere.marathon.example.plugin.http.WebJarHandler",
            "info": {
                "version": "1.2.3",
                "array": [ 1, 2, 3, 4, 5, 6 ],
                "test": true
            },
            "plugin": "mesosphere.marathon.plugin.http.HttpRequestHandler",
            "tags": [ "webjar", "test" ]
        }
    ]
}

URI Parameters

• plugin_id: required (string)
• path: required (string)

URI Parameters

• plugin_id: required (string)
• path: required (string)

URI Parameters

• plugin_id: required (string)
• path: required (string)

URI Parameters

• plugin_id: required (string)
• path: required (string)

HTTP status code 200

the list of all tasks waiting to be scheduled.

Body

Type: application/json

Example:

{
  "queue": [
    {
      "app": {
        "id": "/tools/datadog-agent",
        "cmd": null,
        "args": null,
        "user": null,
        "env": { },
        "instances": 5,
        "cpus": 1.0,
        "mem": 512.0,
        "disk": 0.0,
        "executor": "",
        "constraints": [
          [
            "hostname",
            "UNIQUE"
          ]
        ],
        "uris": [],
        "storeUrls": [],
        "ports": [
          10018
        ],
        "requirePorts": false,
        "backoffSeconds": 1,
        "backoffFactor": 1.15,
        "maxLaunchDelaySeconds": 3600,
        "container": {
          "type": "DOCKER",
          "volumes": [ ],
          "docker": {
            "image": "datadog/docker-dd-agent:latest",
            "network": "HOST",
            "privileged": true,
            "parameters": [],
            "forcePullImage": false
          }
        },
        "healthChecks": [],
        "dependencies": [],
        "upgradeStrategy": {
          "minimumHealthCapacity": 0.5,
          "maximumOverCapacity": 0.0
        },
        "labels": {},
        "acceptedResourceRoles": null,
        "version": "2015-08-26T22:33:24.225Z",
        "versionInfo": {
          "lastScalingAt": "2015-08-26T22:33:24.225Z",
          "lastConfigChangeAt": "2015-05-19T13:59:18.899Z"
        }
      },
      "count": 1,
      "delay": {
        "timeLeftSeconds": 0,
        "overdue": true
      }
    },
    {
      "app": {
        "id": "/foo",
        "cmd": null,
        "args": null,
        "user": "root",
        "env": {
          "MASTER": "zk://172.16.0.12:2181,172.16.0.13:2181,172.16.0.14:2181/mesos"
        },
        "instances": 1,
        "cpus": 0.5,
        "mem": 128.0,
        "disk": 0.0,
        "executor": "//cmd",
        "constraints": [
          [
            "hostname",
            "UNIQUE"
          ]
        ],
        "uris": [
          "http://www.mesosphere.io/index.html"
        ],
        "storeUrls": [],
        "ports": [
          10010
        ],
        "requirePorts": false,
        "backoffSeconds": 1,
        "backoffFactor": 1.15,
        "maxLaunchDelaySeconds": 3600,
        "container": {
          "type": "DOCKER",
          "volumes": [],
          "docker": {
            "image": "thomasr/dispatch",
            "network": "HOST",
            "privileged": false,
            "parameters": [],
            "forcePullImage": false
          }
        },
        "healthChecks": [],
        "dependencies": [],
        "upgradeStrategy": {
          "minimumHealthCapacity": 1.0,
          "maximumOverCapacity": 1.0
        },
        "labels": {},
        "acceptedResourceRoles": null,
        "version": "2015-09-30T09:09:17.614Z",
        "versionInfo": {
          "lastScalingAt": "2015-09-30T09:09:17.614Z",
          "lastConfigChangeAt": "2015-09-30T09:09:17.614Z"
        }
      },
      "count": 2,
      "delay": {
        "timeLeftSeconds": 0,
        "overdue": true
      }
    }
  ]
}

HTTP status code 401

Unauthorized. Authentication is enabled and you did not provide enough or wrong information to authenticate that request.

Body

Type: application/json

Example:

{ "message": "Invalid username or password." }

HTTP status code 403

Forbidden. Authorization is granted but the identity provided does not have sufficient access rights to do that action.

Body

Type: application/json

Example:

{ "message": "Not Authorized to perform this action!" }

URI Parameters

• app_id: required (string)

HTTP status code 200

Every ping is answered with a pong.

Body

Type: text/plain

Example:

pong

HTTP status code 200

All aggregated runtime metrics for this Marathon instance.

Body

Type: application/json

Example:

{
  "counters": {
    "name.of.counter": {
      "count": 1
    }
  },
  "gauges": {
    "name.of.gauge": {
      "value": 7248
    }
  },
  "histograms": {
    "name.of.histogram": {
      "count": 0,
      "max": 0,
      "mean": 0.0,
      "min": 0,
      "p50": 0.0,
      "p75": 0.0,
      "p95": 0.0,
      "p98": 0.0,
      "p99": 0.0,
      "p999": 0.0,
      "stddev": 0.0
    }
  },
  "meters": {
    "name.of.meter": {
      "count": 0,
      "m15_rate": 0.0,
      "m1_rate": 0.0,
      "m5_rate": 0.0,
      "mean_rate": 0.0,
      "units": "events/second"
    }
  },
  "timers": {
    "name.of.timer": {
      "count": 1,
      "duration_units": "seconds",
      "m15_rate": 0.2,
      "m1_rate": 0.2,
      "m5_rate": 0.2,
      "max": 0.0021718640000000003,
      "mean": 0.0021718640000000003,
      "mean_rate": 0.13897812037014803,
      "min": 0.0021718640000000003,
      "p50": 0.0021718640000000003,
      "p75": 0.0021718640000000003,
      "p95": 0.0021718640000000003,
      "p98": 0.0021718640000000003,
      "p99": 0.0021718640000000003,
      "p999": 0.0021718640000000003,
      "rate_units": "calls/second",
      "stddev": 0.0
    }
  },
  "version": "3.0.0"
}