Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

D toc

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

Info

NOTE: Deployments and releases pertain to Production instances of the

D s platform
rtrue
. For more information, see Overview of Deployment Management.


Version: 
v3

Required Permissions

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v3/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 201-300:

Code Block
/v3/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.

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

Code Block
{
    "id": 1,
    "name": "Payment10-SteveO",
    "createdAt": "2017-09-26T07:00:00.000Z",
    "updatedAt": "2017-10-12T23:47:56.801Z",
    "createdBy": 1,
    "updatedBy": 1,
    "releases": [
        {
            "id": 2,
            "notes": "Testing with a new format",
            "packageUuid": "11d472a0-a799-11e7-9c5c-9dd7feba47aa",
            "active": null,
            "createdAt": "2017-10-02T19:07:24.311Z",
            "updatedAt": "2017-10-05T12:21:46.177Z",
            "deploymentId": 1,
            "createdBy": 1,
            "updatedBy": 1
        },
        {
            "id": 1,
            "notes": null,
            "packageUuid": "6648f8c0-a9e6-11e7-a092-8394937c7038",
            "active": true,
            "createdAt": "2017-10-05T16:01:27.881Z",
            "updatedAt": "2017-10-12T20:07:42.143Z",
            "deploymentId": 1,
            "createdBy": 1,
            "updatedBy": 1
        }
    ]
}

Reference

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