Update Check Suite Settings

Update check suite settings for a repository.

PUT /v1/organizations/{org_id}/repos/check-suite-settings

Update Check Suite Settings

cURL

curl --request PUT \
  --url https://api.codegen.com/v1/organizations/{org_id}/repos/check-suite-settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "check_retry_count": 5,
  "ignored_checks": [
    "<string>"
  ],
  "check_retry_counts": {},
  "custom_prompts": {},
  "high_priority_apps": [
    "<string>"
  ]
}
'

import requests

url = "https://api.codegen.com/v1/organizations/{org_id}/repos/check-suite-settings"

payload = {
    "check_retry_count": 5,
    "ignored_checks": ["<string>"],
    "check_retry_counts": {},
    "custom_prompts": {},
    "high_priority_apps": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    check_retry_count: 5,
    ignored_checks: ['<string>'],
    check_retry_counts: {},
    custom_prompts: {},
    high_priority_apps: ['<string>']
  })
};

fetch('https://api.codegen.com/v1/organizations/{org_id}/repos/check-suite-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.codegen.com/v1/organizations/{org_id}/repos/check-suite-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'check_retry_count' => 5,
    'ignored_checks' => [
        '<string>'
    ],
    'check_retry_counts' => [
        
    ],
    'custom_prompts' => [
        
    ],
    'high_priority_apps' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.codegen.com/v1/organizations/{org_id}/repos/check-suite-settings"

	payload := strings.NewReader("{\n  \"check_retry_count\": 5,\n  \"ignored_checks\": [\n    \"<string>\"\n  ],\n  \"check_retry_counts\": {},\n  \"custom_prompts\": {},\n  \"high_priority_apps\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.codegen.com/v1/organizations/{org_id}/repos/check-suite-settings")
  .header("Content-Type", "application/json")
  .body("{\n  \"check_retry_count\": 5,\n  \"ignored_checks\": [\n    \"<string>\"\n  ],\n  \"check_retry_counts\": {},\n  \"custom_prompts\": {},\n  \"high_priority_apps\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.codegen.com/v1/organizations/{org_id}/repos/check-suite-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"check_retry_count\": 5,\n  \"ignored_checks\": [\n    \"<string>\"\n  ],\n  \"check_retry_counts\": {},\n  \"custom_prompts\": {},\n  \"high_priority_apps\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Query Parameters

repo_id · integer · required

Repository ID

Body

application/json

Request model for updating check suite settings.

check_retry_count · integer | null

Global retry count for failed checks

Required range: 0 <= x <= 10

ignored_checks · string[] | null

List of check names to ignore

check_retry_counts · Check Retry Counts · object | null

Per-check retry counts

Show child attributes

custom_prompts · Custom Prompts · object | null

Custom prompts per check

Show child attributes

high_priority_apps · string[] | null

Apps that trigger immediate processing on failure

Response

200

application/json

Successful Response

The response is of type Response Update Check Suite Settings V1 Organizations Org Id Repos Check Suite Settings Put · object.