Get Flaky Tests Management policies

POST https://api.ap1.datadoghq.com/api/v2/ci/test-optimization/settings/policieshttps://api.ap2.datadoghq.com/api/v2/ci/test-optimization/settings/policieshttps://api.datadoghq.eu/api/v2/ci/test-optimization/settings/policieshttps://api.ddog-gov.com/api/v2/ci/test-optimization/settings/policieshttps://api.us2.ddog-gov.com/api/v2/ci/test-optimization/settings/policieshttps://api.datadoghq.com/api/v2/ci/test-optimization/settings/policieshttps://api.us3.datadoghq.com/api/v2/ci/test-optimization/settings/policieshttps://api.us5.datadoghq.com/api/v2/ci/test-optimization/settings/policies

Overview

Retrieve Flaky Tests Management repository-level policies for the given repository. This endpoint requires the test_optimization_read permission.

OAuth apps require the test_optimization_read authorization scope to access this endpoint.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Data object for get Flaky Tests Management policies request.

attributes [required]

object

Attributes for requesting Flaky Tests Management policies.

repository_id [required]

string

The repository identifier.

type [required]

enum

JSON:API type for get Flaky Tests Management policies request. The value must always be test_optimization_get_flaky_tests_management_policies_request. Allowed enum values: test_optimization_get_flaky_tests_management_policies_request

{
  "data": {
    "attributes": {
      "repository_id": "github.com/datadog/shopist"
    },
    "type": "test_optimization_get_flaky_tests_management_policies_request"
  }
}

Response

OK

Response object containing Flaky Tests Management policies for a repository.

Expand All

Field

Type

Description

data

object

Data object for Flaky Tests Management policies response.

attributes

object

Attributes of the Flaky Tests Management policies for a repository.

attempt_to_fix

object

Configuration for the attempt-to-fix Flaky Tests Management policy.

retries

int64

Number of retries when attempting to fix a flaky test. Must be greater than 0.

disabled

object

Configuration for the disabled Flaky Tests Management policy.

auto_disable_rule

object

Automatic disable triggering rule based on a time window and test status.

enabled

boolean

Whether this auto-disable rule is enabled.

status

enum

Test status that the disable policy applies to. Must be either active or quarantined. Allowed enum values: active,quarantined

window_seconds

int64

Time window in seconds over which flakiness is evaluated. Must be greater than 0.

branch_rule

object

Branch filtering rule for a Flaky Tests Management policy.

branches

[string]

List of branches to which the policy applies.

enabled

boolean

Whether this branch rule is enabled.

excluded_branches

[string]

List of branches excluded from the policy.

excluded_test_services

[string]

List of test services excluded from the policy.

enabled

boolean

Whether the disabled policy is enabled.

failure_rate_rule

object

Failure-rate-based rule for the disabled policy.

branches

[string]

List of branches to which this rule applies.

enabled

boolean

Whether this failure rate rule is enabled.

min_runs

int64

Minimum number of runs required before the rule is evaluated. Must be greater than or equal to 0.

status

enum

Test status that the disable policy applies to. Must be either active or quarantined. Allowed enum values: active,quarantined

threshold

double

Failure rate threshold (0.0–1.0) above which the rule triggers.

quarantined

object

Configuration for the quarantined Flaky Tests Management policy.

auto_quarantine_rule

object

Automatic quarantine triggering rule based on a time window.

enabled

boolean

Whether this auto-quarantine rule is enabled.

window_seconds

int64

Time window in seconds over which flakiness is evaluated. Must be greater than 0.

branch_rule

object

Branch filtering rule for a Flaky Tests Management policy.

branches

[string]

List of branches to which the policy applies.

enabled

boolean

Whether this branch rule is enabled.

excluded_branches

[string]

List of branches excluded from the policy.

excluded_test_services

[string]

List of test services excluded from the policy.

enabled

boolean

Whether the quarantined policy is enabled.

failure_rate_rule

object

Failure-rate-based rule for the quarantined policy.

branches

[string]

List of branches to which this rule applies.

enabled

boolean

Whether this failure rate rule is enabled.

min_runs

int64

Minimum number of runs required before the rule is evaluated. Must be greater than or equal to 0.

threshold

double

Failure rate threshold (0.0–1.0) above which the rule triggers.

repository_id

string

The repository identifier.

id

string

The repository identifier used as the resource ID.

type

enum

JSON:API type for Flaky Tests Management policies response. The value must always be test_optimization_flaky_tests_management_policies. Allowed enum values: test_optimization_flaky_tests_management_policies

{
  "data": {
    "attributes": {
      "attempt_to_fix": {
        "retries": 3
      },
      "disabled": {
        "auto_disable_rule": {
          "enabled": false,
          "status": "active",
          "window_seconds": 3600
        },
        "branch_rule": {
          "branches": [
            "main"
          ],
          "enabled": true,
          "excluded_branches": [
            []
          ],
          "excluded_test_services": [
            []
          ]
        },
        "enabled": false,
        "failure_rate_rule": {
          "branches": [
            []
          ],
          "enabled": false,
          "min_runs": 10,
          "status": "active",
          "threshold": 0.5
        }
      },
      "quarantined": {
        "auto_quarantine_rule": {
          "enabled": true,
          "window_seconds": 3600
        },
        "branch_rule": {
          "branches": [
            "main"
          ],
          "enabled": true,
          "excluded_branches": [
            []
          ],
          "excluded_test_services": [
            []
          ]
        },
        "enabled": true,
        "failure_rate_rule": {
          "branches": [
            "main"
          ],
          "enabled": true,
          "min_runs": 10,
          "threshold": 0.5
        }
      },
      "repository_id": "github.com/datadog/shopist"
    },
    "id": "github.com/datadog/shopist",
    "type": "test_optimization_flaky_tests_management_policies"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/ci/test-optimization/settings/policies" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "repository_id": "github.com/example-org/example-repo" }, "type": "test_optimization_get_flaky_tests_management_policies_request" } } EOF
"""
Get Flaky Tests Management policies returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.test_optimization_api import TestOptimizationApi
from datadog_api_client.v2.model.test_optimization_flaky_tests_management_policies_get_request import (
    TestOptimizationFlakyTestsManagementPoliciesGetRequest,
)
from datadog_api_client.v2.model.test_optimization_flaky_tests_management_policies_get_request_attributes import (
    TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes,
)
from datadog_api_client.v2.model.test_optimization_flaky_tests_management_policies_get_request_data import (
    TestOptimizationFlakyTestsManagementPoliciesGetRequestData,
)
from datadog_api_client.v2.model.test_optimization_get_flaky_tests_management_policies_request_data_type import (
    TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType,
)

body = TestOptimizationFlakyTestsManagementPoliciesGetRequest(
    data=TestOptimizationFlakyTestsManagementPoliciesGetRequestData(
        attributes=TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes(
            repository_id="github.com/datadog/shopist",
        ),
        type=TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType.TEST_OPTIMIZATION_GET_FLAKY_TESTS_MANAGEMENT_POLICIES_REQUEST,
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = TestOptimizationApi(api_client)
    response = api_instance.get_flaky_tests_management_policies(body=body)

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get Flaky Tests Management policies returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::TestOptimizationAPI.new

body = DatadogAPIClient::V2::TestOptimizationFlakyTestsManagementPoliciesGetRequest.new({
  data: DatadogAPIClient::V2::TestOptimizationFlakyTestsManagementPoliciesGetRequestData.new({
    attributes: DatadogAPIClient::V2::TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes.new({
      repository_id: "github.com/datadog/shopist",
    }),
    type: DatadogAPIClient::V2::TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType::TEST_OPTIMIZATION_GET_FLAKY_TESTS_MANAGEMENT_POLICIES_REQUEST,
  }),
})
p api_instance.get_flaky_tests_management_policies(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get Flaky Tests Management policies returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.TestOptimizationFlakyTestsManagementPoliciesGetRequest{
		Data: datadogV2.TestOptimizationFlakyTestsManagementPoliciesGetRequestData{
			Attributes: datadogV2.TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes{
				RepositoryId: "github.com/datadog/shopist",
			},
			Type: datadogV2.TESTOPTIMIZATIONGETFLAKYTESTSMANAGEMENTPOLICIESREQUESTDATATYPE_TEST_OPTIMIZATION_GET_FLAKY_TESTS_MANAGEMENT_POLICIES_REQUEST,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewTestOptimizationApi(apiClient)
	resp, r, err := api.GetFlakyTestsManagementPolicies(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TestOptimizationApi.GetFlakyTestsManagementPolicies`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `TestOptimizationApi.GetFlakyTestsManagementPolicies`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get Flaky Tests Management policies returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.TestOptimizationApi;
import com.datadog.api.client.v2.model.TestOptimizationFlakyTestsManagementPoliciesGetRequest;
import com.datadog.api.client.v2.model.TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes;
import com.datadog.api.client.v2.model.TestOptimizationFlakyTestsManagementPoliciesGetRequestData;
import com.datadog.api.client.v2.model.TestOptimizationFlakyTestsManagementPoliciesResponse;
import com.datadog.api.client.v2.model.TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    TestOptimizationApi apiInstance = new TestOptimizationApi(defaultClient);

    TestOptimizationFlakyTestsManagementPoliciesGetRequest body =
        new TestOptimizationFlakyTestsManagementPoliciesGetRequest()
            .data(
                new TestOptimizationFlakyTestsManagementPoliciesGetRequestData()
                    .attributes(
                        new TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes()
                            .repositoryId("github.com/datadog/shopist"))
                    .type(
                        TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType
                            .TEST_OPTIMIZATION_GET_FLAKY_TESTS_MANAGEMENT_POLICIES_REQUEST));

    try {
      TestOptimizationFlakyTestsManagementPoliciesResponse result =
          apiInstance.getFlakyTestsManagementPolicies(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling TestOptimizationApi#getFlakyTestsManagementPolicies");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// Get Flaky Tests Management policies returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_test_optimization::TestOptimizationAPI;
use datadog_api_client::datadogV2::model::TestOptimizationFlakyTestsManagementPoliciesGetRequest;
use datadog_api_client::datadogV2::model::TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes;
use datadog_api_client::datadogV2::model::TestOptimizationFlakyTestsManagementPoliciesGetRequestData;
use datadog_api_client::datadogV2::model::TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType;

#[tokio::main]
async fn main() {
    let body =
        TestOptimizationFlakyTestsManagementPoliciesGetRequest::new(
            TestOptimizationFlakyTestsManagementPoliciesGetRequestData::new(
                TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes::new(
                    "github.com/datadog/shopist".to_string(),
                ),
                TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType
                ::TEST_OPTIMIZATION_GET_FLAKY_TESTS_MANAGEMENT_POLICIES_REQUEST,
            ),
        );
    let configuration = datadog::Configuration::new();
    let api = TestOptimizationAPI::with_config(configuration);
    let resp = api.get_flaky_tests_management_policies(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Get Flaky Tests Management policies returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.TestOptimizationApi(configuration);

const params: v2.TestOptimizationApiGetFlakyTestsManagementPoliciesRequest = {
  body: {
    data: {
      attributes: {
        repositoryId: "github.com/datadog/shopist",
      },
      type: "test_optimization_get_flaky_tests_management_policies_request",
    },
  },
};

apiInstance
  .getFlakyTestsManagementPolicies(params)
  .then((data: v2.TestOptimizationFlakyTestsManagementPoliciesResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"