Get the list of accessible deployments for the authenticated user.

NOTE: Deployments 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

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?limit=100&offset=2

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

Query Parameter reference:

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

The following query parameters are specific to this endpoint:

Query ParameterDescription
deploymentIdInternal identifier of the deployment

For more information, see API Common Query Parameters v4.

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "data": [
        {
            "id": 2,
            "name": "Test Deployment 2",
            "createdAt": "2019-02-13T20:15:39.147Z",
            "updatedAt": "2019-02-13T20:15:39.147Z",
            "numReleases": 0,
            "latestRelease": null,
            "creator": {
                "id": 7
            },
            "updater": {
                "id": 7
            }
        },
        {
            "id": 1,
            "name": "Test Deployment",
            "createdAt": "2019-02-13T20:14:48.537Z",
            "updatedAt": "2019-02-13T20:14:48.537Z",
            "numReleases": 0,
            "latestRelease": null,
            "creator": {
                "id": 7
            },
            "updater": {
                "id": 7
            }
        }
    ]
}

Reference

For more information on the properties of a deployment, see API Deployments Get v4