Request

This request uses the POST method, which links a run configuration to a specified release by providing the release ID. A successful request returns the updated runConfiguration object with the linked release details.

For basic authorization, replace this with your API token in the header request in the Authorization: Bearer {your_api_token} format. The token must be valid and have sufficient permissions 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 you want to link to the release. This is included in the URL path.
releaseId (Request Body): A string that specifies the unique identifier of the release to link.

Response

A successful response returns the updated run configuration object, including the details of the linked release. The response is provided in JSON format.

{
  "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:

Property	Type	Description
`id`	Integer	The unique identifier of the run configuration.
`name`	String	The name of the run configuration.
`release`	Object	Details of the linked release, including the release ID and name.
`status`	String	Indicates the linking status: `QUEUED` `RUNNING` `FAILED` `SUCCESS` `CANCELED` `ERROR` `WAIT_FOR_TRIGGER` `EXPIRED`
`updatedAt`	String	The timestamp when the run configuration was last updated in ISO 8601 format.

Try it!

Provide the required parameters and values below (click the dropdown and plus icons):
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!

200OK