deployments.md 6.61 KB
Newer Older
Z.J. van de Weg's avatar
Z.J. van de Weg committed
1 2 3 4 5 6 7 8 9 10 11 12
# Deployments API

## List project deployments

Get a list of deployments in a project.

```
GET /projects/:id/deployments
```

| Attribute | Type    | Required | Description         |
|-----------|---------|----------|---------------------|
13
| `id`      | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
Jacopo's avatar
Jacopo committed
14 15
| `order_by`| string  | no       | Return deployments ordered by `id` or `iid` or `created_at` or `ref` fields. Default is `id` |
| `sort`    | string  | no       | Return deployments sorted in `asc` or `desc` order. Default is `asc` |
Z.J. van de Weg's avatar
Z.J. van de Weg committed
16 17

```bash
18
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/deployments"
Z.J. van de Weg's avatar
Z.J. van de Weg committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
```

Example of response

```json
[
  {
    "created_at": "2016-08-11T07:36:40.222Z",
    "deployable": {
      "commit": {
        "author_email": "admin@example.com",
        "author_name": "Administrator",
        "created_at": "2016-08-11T09:36:01.000+02:00",
        "id": "99d03678b90d914dbb1b109132516d71a4a03ea8",
        "message": "Merge branch 'new-title' into 'master'\r\n\r\nUpdate README\r\n\r\n\r\n\r\nSee merge request !1",
        "short_id": "99d03678",
        "title": "Merge branch 'new-title' into 'master'\r"
      },
      "coverage": null,
      "created_at": "2016-08-11T07:36:27.357Z",
      "finished_at": "2016-08-11T07:36:39.851Z",
      "id": 657,
      "name": "deploy",
      "ref": "master",
      "runner": null,
      "stage": "deploy",
      "started_at": null,
      "status": "success",
      "tag": false,
      "user": {
49 50 51 52
        "id": 1,
        "name": "Administrator",
        "username": "root",
        "state": "active",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
53
        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
54 55
        "web_url": "http://gitlab.dev/root",
        "created_at": "2015-12-21T13:14:24.077Z",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
56 57
        "bio": null,
        "location": null,
58
        "public_email": "",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
59
        "skype": "",
60
        "linkedin": "",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
61
        "twitter": "",
62 63
        "website_url": "",
        "organization": ""
Z.J. van de Weg's avatar
Z.J. van de Weg committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
      }
    },
    "environment": {
      "external_url": "https://about.gitlab.com",
      "id": 9,
      "name": "production"
    },
    "id": 41,
    "iid": 1,
    "ref": "master",
    "sha": "99d03678b90d914dbb1b109132516d71a4a03ea8",
    "user": {
      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "id": 1,
      "name": "Administrator",
      "state": "active",
      "username": "root",
81
      "web_url": "http://localhost:3000/root"
Z.J. van de Weg's avatar
Z.J. van de Weg committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
    }
  },
  {
    "created_at": "2016-08-11T11:32:35.444Z",
    "deployable": {
      "commit": {
        "author_email": "admin@example.com",
        "author_name": "Administrator",
        "created_at": "2016-08-11T13:28:26.000+02:00",
        "id": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
        "message": "Merge branch 'rename-readme' into 'master'\r\n\r\nRename README\r\n\r\n\r\n\r\nSee merge request !2",
        "short_id": "a91957a8",
        "title": "Merge branch 'rename-readme' into 'master'\r"
      },
      "coverage": null,
      "created_at": "2016-08-11T11:32:24.456Z",
      "finished_at": "2016-08-11T11:32:35.145Z",
      "id": 664,
      "name": "deploy",
      "ref": "master",
      "runner": null,
      "stage": "deploy",
      "started_at": null,
      "status": "success",
      "tag": false,
      "user": {
108 109 110 111
        "id": 1,
        "name": "Administrator",
        "username": "root",
        "state": "active",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
112
        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
113 114
        "web_url": "http://gitlab.dev/root",
        "created_at": "2015-12-21T13:14:24.077Z",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
115 116
        "bio": null,
        "location": null,
117
        "public_email": "",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
118
        "skype": "",
119
        "linkedin": "",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
120
        "twitter": "",
121 122
        "website_url": "",
        "organization": ""
Z.J. van de Weg's avatar
Z.J. van de Weg committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
      }
    },
    "environment": {
      "external_url": "https://about.gitlab.com",
      "id": 9,
      "name": "production"
    },
    "id": 42,
    "iid": 2,
    "ref": "master",
    "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
    "user": {
      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "id": 1,
      "name": "Administrator",
      "state": "active",
      "username": "root",
140
      "web_url": "http://localhost:3000/root"
Z.J. van de Weg's avatar
Z.J. van de Weg committed
141 142 143 144 145 146 147 148 149 150 151 152 153
    }
  }
]
```

## Get a specific deployment

```
GET /projects/:id/deployments/:deployment_id
```

| Attribute | Type    | Required | Description         |
|-----------|---------|----------|---------------------|
154
| `id`      | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
Z.J. van de Weg's avatar
Z.J. van de Weg committed
155
| `deployment_id` | integer | yes      | The ID of the deployment |
Z.J. van de Weg's avatar
Z.J. van de Weg committed
156 157

```bash
158
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/deployments/1"
Z.J. van de Weg's avatar
Z.J. van de Weg committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
```

Example of response

```json
{
  "id": 42,
  "iid": 2,
  "ref": "master",
  "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
  "created_at": "2016-08-11T11:32:35.444Z",
  "user": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
176
    "web_url": "http://localhost:3000/root"
Z.J. van de Weg's avatar
Z.J. van de Weg committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
  },
  "environment": {
    "id": 9,
    "name": "production",
    "external_url": "https://about.gitlab.com"
  },
  "deployable": {
    "id": 664,
    "status": "success",
    "stage": "deploy",
    "name": "deploy",
    "ref": "master",
    "tag": false,
    "coverage": null,
    "created_at": "2016-08-11T11:32:24.456Z",
    "started_at": null,
    "finished_at": "2016-08-11T11:32:35.145Z",
    "user": {
195
      "id": 1,
Z.J. van de Weg's avatar
Z.J. van de Weg committed
196 197 198 199
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
200 201
      "web_url": "http://gitlab.dev/root",
      "created_at": "2015-12-21T13:14:24.077Z",
Z.J. van de Weg's avatar
Z.J. van de Weg committed
202 203 204 205 206
      "bio": null,
      "location": null,
      "skype": "",
      "linkedin": "",
      "twitter": "",
207 208
      "website_url": "",
      "organization": ""
Z.J. van de Weg's avatar
Z.J. van de Weg committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222
    },
    "commit": {
      "id": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
      "short_id": "a91957a8",
      "title": "Merge branch 'rename-readme' into 'master'\r",
      "author_name": "Administrator",
      "author_email": "admin@example.com",
      "created_at": "2016-08-11T13:28:26.000+02:00",
      "message": "Merge branch 'rename-readme' into 'master'\r\n\r\nRename README\r\n\r\n\r\n\r\nSee merge request !2"
    },
    "runner": null
  }
}
```