Link a schedule to a build

A successful request to this endpoint links a scheduled test run to a build. This method returns the updated scheduled test run with the linked build.

Request

This request uses the POST method, which is used to link a scheduled test run (runConfiguration object) to a specified build. A successful request returns the updated scheduled test run with the associated build details.

For basic authorization, use your actual API key in the header request in the Authorization: Bearer {your_api_token} format. The token must be valid and authorized to modify run configurations.

The request data is provided as a JSON object.

You need to provide the following required parameters:

  • id (Path Parameter): The unique identifier of the run configuration to be linked to the build.
  • buildId (Request Body): A string representing the unique identifier of the build to link to the run configuration.

Example request

POST https://testops.katalon.io/api/v1/run-configurations/{id}/link-build
Content-Type: application/json
Authorization: Bearer {your_api_token}

{
  "buildId": "67890"
}

Response

A successful response returns the updated runConfiguration object, including the linked build details.

Example response

{
  "id": 12345,
  "name": "Daily Smoke Test",
  "build": {
    "id": "67890",
    "name": "Build 1.2.3"
  },
  "status": "linked",
  "updatedAt": "2025-01-17T12:00:00Z"
}

Refer to the following table about the response body properties:

Parameter

Type

Description

id

Integer

The unique identifier of the run configuration.

name

String

The name of the scheduled test run.

build

Object

An object containing details of the linked build.

build.id

String

The unique identifier of the linked build.

build.name

String

The name of the linked build.

status

String

The status of the linking operation:

  • QUEUED
  • RUNNING
  • FAILED
  • SUCCESS
  • CANCELED
  • ERROR
  • WAIT_FOR_TRIGGER
  • EXPIRED

updatedAt

String

The timestamp of when the run configuration was last updated, in ISO 8601 format.


Try it!

  1. Provide the required parameters and values below (click the dropdown and plus icons):
  2. Select the language in Language.
  3. Enter your user name or API credentials.
  4. Review your API call and click Try it!
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!