Get the list of releases for the specified deployment for the authenticated user.

NOTE: Deployments and releases pertain to Production instances of the . For more information, see Overview of Deployment Manager.


Version: 
v4

Required Permissions

Request

Request Type: GET

Endpoint:

/v4/deployments/:id?embed=releases

Endpoint with paged retrieval:

By default, this endpoint returns results in sets of 25. 

You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 3-102:

/v4/deployments/:id?embed=releases&limit=100&offset=2

If the count of retrieved results is less than the limit, you have reached the end of the results.

Endpoint with release information only:

If needed, you can use the following endpoint to return only the release information for the specified deployment:

/v4/releases?deploymentId=:id&limit=100&offset=0

Query Parameter reference:

The following query parameters are supported for this type of endpoint.

For more information, see API Common Query Parameters v4.


Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "id": 1,
    "name": "2013 POS",
    "createdAt": "2019-03-27T17:45:14.837Z",
    "updatedAt": "2019-03-27T17:45:14.837Z",
    "releases": {
        "data": [
            {
                "id": 1,
                "notes": "v01",
                "packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
                "active": null,
                "createdAt": "2019-03-27T17:45:48.345Z",
                "updatedAt": "2019-03-27T17:46:24.675Z",
                "deployment": {
                    "id": 1
                },
                "creator": {
                    "id": 2
                },
                "updater": {
                    "id": 2
                }
            },
            {
                "id": 2,
                "notes": "v02",
                "packageUuid": "ff8738c0-50b7-11e9-ba15-93c82271a00b",
                "active": true,
                "createdAt": "2019-03-27T17:46:24.671Z",
                "updatedAt": "2019-03-27T17:46:24.671Z",
                "deployment": {
                    "id": 1
                },
                "creator": {
                    "id": 2
                },
                "updater": {
                    "id": 2
                }
            }
        ]
    },
    "creator": {
        "id": 2
    },
    "updater": {
        "id": 2
    }
}

Response - release only information:

{
    "data": [
        {
            "id": 2,
            "notes": "v02",
            "packageUuid": "ff8738c0-50b7-11e9-ba15-93c82271a00b",
            "active": true,
            "createdAt": "2019-03-27T17:46:24.671Z",
            "updatedAt": "2019-03-27T17:46:24.671Z",
            "deployment": {
                "id": 1
            },
            "creator": {
                "id": 2
            },
            "updater": {
                "id": 2
            }
        },
        {
            "id": 1,
            "notes": "v01",
            "packageUuid": "f9cab740-50b7-11e9-ba15-93c82271a00b",
            "active": null,
            "createdAt": "2019-03-27T17:45:48.345Z",
            "updatedAt": "2019-03-27T17:46:24.675Z",
            "deployment": {
                "id": 1
            },
            "creator": {
                "id": 2
            },
            "updater": {
                "id": 2
            }
        }
    ]
}

 

Reference

For more information on the properties of a release, see API Releases Get v4