Deployments

A Deployment is a publish event of a Release to a Cohort.

Request Schema

Field	Type	Description
`type` Required	`String`	`normal` or `staged_rollout` Example: `"normal"`
`release` Required	`String`	Release ID or Slug Example: `"1.2.3"`
`cohort` Required	`String`	Cohort ID or Slug Example: `"beta"`
`extra_info`	`JSON`	Extra data. Memfault won't process this data, but will store it along with the Deployment

Query Parameters

The following parameters can be used to filter Deployments.

Query Parameter	Type	Description
`release`	`String[]`	Versions of Releases Example: `release=1.2.3&release=1.2.4`
`cohort`	`String[]`	Names of Cohorts Example: `cohort=alpha&cohort=beta`
`since`	`DateTime`	Deployed after this date Example: `"2019-01-19T05:01:13.000000+00:00"`
`until`	`DateTime`	Deployed before this date Example: `"2019-01-19T05:01:13.000000+00:00"`
`sort` Default: `-deployed_date`	`String`	Sort keys (listed below) Example: `-deployed_date`

Sort Parameters

Sort Parameter	Type	Description
`deployed_date`	`DateTime`	Date the Deployment was created

Response Schema

{
  "data": {
    "id": 1,
    "created_date": "2019-01-19T05:01:13.000000+00:00",
    "updated_date": "2019-01-19T05:01:13.000000+00:00",
    "deployed_date": "2019-01-19T05:01:13.000000+00:00",
    "type": "staged_rollout",
    "status": "done",
    "rollout_percent": 100,
    "release": {
      "id": 2,
      "version": "1.2.3",
      "revision": "11d95ef20f7a048ce1da1a6891dd3e2f92c89d85"
    },
    "cohort": {
      "id": 1,
      "name": "Beta Channel",
      "slug": "beta"
    },
    "deployer": {
      "id": 1,
      "email": "user@example.com",
      "name": "Robert S"
    },
    "extra_info": {
      "anything": "you_want",
      "ci_system": "Jenkins"
    }
  }
}