Pipeline feedback integrations

Releases API

Our Releases API provides endpoints to create, read, update, and delete a release. Release markers can be created with four different scopes:

• Global
• Application Perspective
• Service
• Service within an Application Perspective

In the following example, a curl command is used to create a new global release marker named My First Global Release at the given point in time (as UNIX timestamp in milliseconds):

curl --location --request POST "{{base}}/api/releases" \
  --header "Authorization: apiToken {{apiToken}}" \
  --header "Content-Type: application/json" \
  --data "{
	\"name\": \"My First Global Release\",
	\"start\": 1601890420046,
}"

The "start" value needs to be a timestamp in milliseconds.

This release marker is shown on all dashboard pages for Applications, Services, and Endpoints.

To create a release marker based on an existing Application Perspective, add the applications with a list of application names to the request body.

curl --location --request POST "{{base}}/api/releases" \
  --header "Authorization: apiToken {{apiToken}}" \
  --header "Content-Type: application/json" \
  --data "{
	\"name\": \"My First Application Scoped Release\",
	\"start\": 1601890420046,
	\"applications\": [
      {
        \"name\": \"My Application\" 
      }
    ]
}"

This release marker is shown on the dashboard for the Application My Application.

The following snippet shows how to create a release marker for a given service.

curl --location --request POST "{{base}}/api/releases" \
  --header "Authorization: apiToken {{apiToken}}" \
  --header "Content-Type: application/json" \
  --data "{
	\"name\": \"My First Service Scoped Release\",
	\"start\": 1601890420046,
	\"services\": [
      {
        \"name\": "\"my-service\"
      }
    ]
}"

This service scoped release marker is shown on the dashboards for the Service my-service and all Application dashboards that contain the Service my-service. A service scoped release marker can also be created for a given set of applications.

curl --location --request POST "{{base}}/api/releases" \
  --header "Authorization: apiToken {{apiToken}}" \
  --header "Content-Type: application/json" \
  --data "{
	\"name\": \"My First Service Scoped Release\",
	\"start\": 1601890420046,
	\"services\": [
      {
        \"name\": \"my-service\",
        \"scopedTo\": {
          \"applications\": [
            {
              \"name\": \"My Application\"
            }
          ]
        }
      }
    ]
}"

The given Release Marker will be shown only for the Service my-service within the given Application My Application, but not for other services within the Application.

The used API Token requires the permission "Configuration of releases".

Integrations