Releases API - GET releases
Lists all available releases.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/releases |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/releases | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/releases |
Authentication
To execute this request, you need an access token with Read releases (releases.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( | query | optional |
to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. | query | optional |
nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. | query | optional |
pageSize | integer | The amount of Releases in a single response payload. The maximal allowed page size is 1000. If not set, 100 is used. | query | optional |
demo | boolean | Get your Releases ( | query | optional |
releasesSelector | string | Defines the scope of the query. Only Releases matching the provided criteria are included in the response. You can add one or several of the criteria listed below.
To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7"). The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~""). | query | optional |
sort | string | Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:
If not set, the ascending order sorting for name is applied. | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Releases | Success |
Response body objects
The Releases
object
A list of releases.
Element | Type | Description |
---|---|---|
releasesWithProblems | integer | Number of releases with problems. Can be |
releases | Release[] | A list of releases. Can be |
pageSize | integer | The number of entries per page. Can be |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. Can be |
totalCount | integer | The total number of entries in the result. |
The Release
object
Contains data related to a single release of a component. A Release is a combination of a component and a version. A Component can be any form of deployable that can be associated with a version. In the first draft, a Component is always a Service.
The tuple <name, product, stage, version> is always unique.
Element | Type | Description |
---|---|---|
releaseEntityId | string | The entity id of correlating release. Can be |
product | string | The product name Can be |
affectedBySecurityVulnerabilities | boolean | The entity has one or more security vulnerabilities Can be |
throughput | number | The count of bytes per second of the entity Can be |
softwareTechs | Software | The software technologies of the release Can be |
securityVulnerabilitiesCount | integer | The number of security vulnerabilities of the entity Can be |
affectedByProblems | boolean | The entity has one or more problems Can be |
securityVulnerabilitiesEnabled | boolean | Indicates that the security vulnerabilities feature is enabled Can be |
instances | Release | The instances entityIds included in this release Can be |
running | boolean | The related PGI is still running/monitored Can be |
name | string | The entity name Can be |
version | string | The identified release version Can be |
problemCount | integer | The number of problems of the entity Can be |
stage | string | The stage name Can be |
The SoftwareTechs
object
Contains information about the used software technology.
Element | Type | Description |
---|---|---|
edition | string | The edition of the technology. Can be |
verbatimType | string | The verbatim type of the technology. Can be |
technology | string | The type of the technology. Can be |
version | string | The version of the technology. Can be |
The ReleaseInstance
object
Contains data related to a single instance of a release. An instance is a Process Group Instance and has an optional build version.
Element | Type | Description |
---|---|---|
buildVersion | string | The build version Can be |
securityVulnerabilities | string[] | List of Security vulnerabilities Ids Can be |
entityId | string | The entity id of the instance. Can be |
problems | string[] | List of event Ids of open problems Can be |
Response body JSON model
{
"releasesWithProblems": 1,
"releases": [
{
"releaseEntityId": "PROCESS_GROUP-DFDBAC9CBF104253",
"product": "Sockshop",
"affectedBySecurityVulnerabilities": true,
"throughput": 923234,
"softwareTechs": [
{
"technology": "JAVA",
"edition": "OpenJDK",
"version": "1.8.0_242",
"verbatimType": "Java"
}
],
"securityVulnerabilitiesCount": 4,
"affectedByProblems": true,
"securityVulnerabilitiesEnabled": true,
"instances": [
"PROCESS_GROUP_INSTANCE-49D94B90FB71C45B",
"PROCESS_GROUP_INSTANCE-7EA049157C82D1A5"
],
"running": true,
"name": "cluster",
"version": "1.195.34.12341232423-012342",
"problemCount": 4,
"stage": "staging"
}
],
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1
}