Create a release

A successful request to this endpoint creates a new release. This method returns all applicable details of the newly-created release.


This request uses the POST method, which is used to create a new release using Katalon TestOps from the specified resource.

For basic authorization, replace this with your actual username and password (or API key) in the header request in the username:password or username:api_key format. Your user creds are combined to form a Base64 encoded string.

The request data is provided as a JSON object.

You need to provide the following required query parameters:

  • name: Name of your release.
  • projectId: The alphanumeric ID of the project.


This API response provides information about the newly-created project.

See the following example of a newly-created project:

  "id": 299421,
  "name": "Demo test",
  "startTime": "2022-11-29",
  "endTime": "2022-12-29",
  "projectId": xxx,
  "closed": false,
  "createdAt": "2022-11-29T08:32:49.534+0000",
  "externalRelease": {},
  "releaseStatistics": {},
  "builds": [],
  "releaseStatus": "EMPTY"

Refer to the following table about the response body parameters:

idintegerThe unique identifier of the release.
namestringThe name of the release.
startTimedateThe date when the planning of release should start.
endTimedateThe date when the release should end.
descriptionstringThe description of the release.
projectIdintegerThe ID of the associated project.
closedbooleantrue if the release is archived.
createdAtdatetimeThe date and time when the release is created.
externalReleaseExternalRelease objectThe linked Jira release.
See: Populate Jira releases.
releaseStatisticsReleaseStatistics objectThis object contains statistics of the release: passed test cases, failed test cases, defects, etc.
buildsarray of build objectsThe associated builds.
See: Create and manage builds.
releaseStatusstringThe status of the release:

Try it!

  1. Enter the projectID below and your preferred name of your release.
  1. Select the language in Language.
  2. Enter your user name or API credentials.
  3. Review your API call and click Try it!
Click Try It! to start a request and see the response here!