Deploys

Deploys describe the delivery process and setting of the project. We will see how to get the list of deploys and their properties.

The deploys model

The deploys model contains essential information about the delivery and environment of a project, team, and developer source code.

Properties

Name
id
Type
string
Description
Unique identifier for the deploy.
Name
url
Type
string
Description
The url for the deploy.
Name
sha
Type
string
Description
Associated commit id.
Name
originalEnvironment
Type
string
Description
The original environment for the deploy.
Name
environment
Type
string
Description
The environment for the deploy.
Name
userId
Type
string
Description
The author user Id of the deploy.
Name
createdAt
Type
timestamp
Description
Timestamp of when the deploy was created.
Name
updatedAt
Type
timestamp
Description
Timestamp of when the deploy was updated.
Name
repositoryId
Type
string
Description
The id of the repository.
Name
provider
Type
string
Description
The name of the provider.

GET/api/dashboard/deploys

List all deploys

Request

GET

/api/dashboard/deploys

curl -G https://api.pulzen-gateway/api/dashboard/deploys \
  -H "Authorization: Basic {token}"

Response

{
    "url": "https://github.com/CleveritDemo/taylor-backend/deployments/DE_kwDOJqnfd845ZNWj",
    "id": "DE_kwDOJqnfd845ZNWj",
    "sha": "598662ed6165e408e2032ee3ecdbf3bdbeaf60c7",
    "originalEnvironment": "develop",
    "environment": "develop",
    "login": "WilRodAcero",
    "userId": "WilRodAcero",
    "createdAt": "2023-06-27T23:05:39Z",
    "updatedAt": "2023-06-28T01:06:10Z",
    "repositoryId": "R_kgDOJqnfdw",
    "provider": "GITHUB",
    "isRelease": null,
    "releasePublishedAt": null,
    "deployTimeIsRelease": null
}

Query Parameters:

provider: Can be one of the following: GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS.
dateStart: Format YYYY-MM-DD.
dateEnd: Format YYYY-MM-DD.