Flaky Tests API

The Trunk Flaky Tests API provides access to check the status of Trunk services and fetch unhealthy or quarantined tests in your project. The API is an HTTP REST API, returns JSON from all requests, and uses standard HTTP response codes.

All requests must be authenticated by providing the x-api-token header.

Get the details of a test case

post

Authorizations

x-api-tokenstringRequired

Body

org_url_slugstringRequired

The slug of your organization. Find this at https://app.trunk.io/trunk/settings under "Organization Name" > "Slug"

Example: my-trunk-org-slug

test_idstring · uuidRequired

The id of a test case. Should be a UUID.

Example: 01234567-0123-0123-0123-0123456789ab

Responses

200

application/json

401

Unauthorized

application/plain-text

post

/flaky-tests/get-test-details

POST /v1/flaky-tests/get-test-details HTTP/1.1
Host: api.trunk.io
x-api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "repo": {
    "host": "github.com",
    "owner": "my-github-org",
    "name": "my-repo"
  },
  "org_url_slug": "my-trunk-org-slug",
  "test_id": "01234567-0123-0123-0123-0123456789ab"
}

{
  "test": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "repository": {
      "html_url": "https://example.com"
    },
    "html_url": "https://example.com",
    "name": "text",
    "variant": "text",
    "status": {
      "value": "healthy",
      "reason": "text",
      "timestamp": "2026-02-19T13:45:19.281Z"
    },
    "most_common_failures": [
      {
        "summary": "text",
        "occurrence_count": 1,
        "last_occurrence": "2026-02-19T13:45:19.281Z"
      }
    ],
    "failure_rate_last_7d": 1,
    "file_path": "text",
    "parent": "text",
    "classname": "text",
    "codeowners": [
      "text"
    ],
    "pull_requests_impacted_last_7d": 1,
    "quarantined": true,
    "ticket": {
      "html_url": "https://example.com"
    }
  }
}

Link a ticket to a test case

post

Authorizations

x-api-tokenstringRequired

Body

test_case_idstring · uuidRequired

The id of the test case. Should be a UUID.

Example: 01234567-0123-0123-0123-0123456789ab

external_ticket_idstringRequired

The external identifier of the ticket. For Jira this is the ticket number prefixed by the Project Key. For Linear this is the ticket number prefixed by the Team Identifier

Example: KAN-123

Responses

200

application/json

400

Bad Request

application/plain-text

401

Unauthorized

application/plain-text

404

Not Found

application/plain-text

500

Internal Server Error

application/plain-text

post

/flaky-tests/link-ticket-to-test-case

POST /v1/flaky-tests/link-ticket-to-test-case HTTP/1.1
Host: api.trunk.io
x-api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "test_case_id": "01234567-0123-0123-0123-0123456789ab",
  "external_ticket_id": "KAN-123",
  "repo": {
    "host": "github.com",
    "owner": "my-github-org",
    "name": "my-repo"
  }
}

Get a list of distinct tests that failed in the given time range

post

Authorizations

x-api-tokenstringRequired

Body

org_url_slugstringRequired

The slug of your organization. Find this at https://app.trunk.io/trunk/settings under "Organization Name" > "Slug"

Example: my-trunk-org-slug

start_timestring · date-timeRequired

The start time of the failing tests (inclusive). Must be within 7 days of the end time.

end_timestring · date-timeRequired

The end time of the failing tests (exclusive). Must be within 7 days of the start time.

Responses

200

application/json

401

Unauthorized

application/plain-text

post

/flaky-tests/list-failing-tests

POST /v1/flaky-tests/list-failing-tests HTTP/1.1
Host: api.trunk.io
x-api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "repo": {
    "host": "github.com",
    "owner": "my-github-org",
    "name": "my-repo"
  },
  "org_url_slug": "my-trunk-org-slug",
  "start_time": "2026-02-19T13:45:19.281Z",
  "end_time": "2026-02-19T13:45:19.281Z",
  "page_query": {
    "page_size": 1,
    "page_token": ""
  }
}

{
  "tests": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "repository": {
        "html_url": "https://example.com"
      },
      "html_url": "https://example.com",
      "name": "text",
      "variant": "text",
      "status": {
        "value": "healthy",
        "reason": "text",
        "timestamp": "2026-02-19T13:45:19.281Z"
      },
      "most_common_failures": [
        {
          "summary": "text",
          "occurrence_count": 1,
          "last_occurrence": "2026-02-19T13:45:19.281Z"
        }
      ],
      "failure_rate_last_7d": 1,
      "file_path": "text",
      "parent": "text",
      "classname": "text",
      "codeowners": [
        "text"
      ],
      "pull_requests_impacted_last_7d": 1,
      "quarantined": true,
      "ticket": {
        "html_url": "https://example.com"
      }
    }
  ],
  "page": {
    "total_rows": 1,
    "total_pages": 1,
    "next_page_token": "text",
    "prev_page_token": "text",
    "last_page_token": "text",
    "page_index": 1
  }
}

Get a list of unhealthy tests

post

Authorizations

x-api-tokenstringRequired

Body

org_url_slugstringRequired

The slug of your organization. Find this at https://app.trunk.io/trunk/settings under "Organization Name" > "Slug"

Example: my-trunk-org-slug

statusstring · enumRequired

The status filter for unhealthy tests.

Possible values:

Responses

200

application/json

401

Unauthorized

application/plain-text

post

/flaky-tests/list-unhealthy-tests

POST /v1/flaky-tests/list-unhealthy-tests HTTP/1.1
Host: api.trunk.io
x-api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "repo": {
    "host": "github.com",
    "owner": "my-github-org",
    "name": "my-repo"
  },
  "org_url_slug": "my-trunk-org-slug",
  "page_query": {
    "page_size": 1,
    "page_token": ""
  },
  "status": "FLAKY"
}

{
  "tests": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "repository": {
        "html_url": "https://example.com"
      },
      "html_url": "https://example.com",
      "name": "text",
      "variant": "text",
      "status": {
        "value": "healthy",
        "reason": "text",
        "timestamp": "2026-02-19T13:45:19.281Z"
      },
      "file_path": "text",
      "parent": "text",
      "classname": "text",
      "codeowners": [
        "text"
      ],
      "pull_requests_impacted_last_7d": 1,
      "quarantined": true,
      "ticket": {
        "html_url": "https://example.com"
      }
    }
  ],
  "page": {
    "total_rows": 1,
    "total_pages": 1,
    "next_page_token": "text",
    "prev_page_token": "text",
    "last_page_token": "text",
    "page_index": 1
  }
}

Get a list of quarantined tests

post

Authorizations

x-api-tokenstringRequired

Body

org_url_slugstringRequired

The slug of your organization. Find this at https://app.trunk.io/trunk/settings under "Organization Name" > "Slug"

Example: my-trunk-org-slug

Responses

200

application/json

401

Unauthorized

application/plain-text

post

/flaky-tests/list-quarantined-tests

POST /v1/flaky-tests/list-quarantined-tests HTTP/1.1
Host: api.trunk.io
x-api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "repo": {
    "host": "github.com",
    "owner": "my-github-org",
    "name": "my-repo"
  },
  "org_url_slug": "my-trunk-org-slug",
  "page_query": {
    "page_size": 1,
    "page_token": ""
  }
}

{
  "quarantined_tests": [
    {
      "name": "text",
      "parent": null,
      "file": null,
      "classname": null,
      "status": "HEALTHY",
      "codeowners": [
        "text"
      ],
      "quarantine_setting": "ALWAYS_QUARANTINE",
      "quarantined_at": "2026-02-19T13:45:19.281Z",
      "status_last_updated_at": "2026-02-19T13:45:19.281Z",
      "test_case_id": "text",
      "variant": "text"
    }
  ],
  "page": {
    "total_rows": 1,
    "total_pages": 1,
    "next_page_token": "text",
    "prev_page_token": "text",
    "last_page_token": "text",
    "page_index": 1
  }
}

Last updated 3 months ago

hashtagGet the details of a test case

hashtagLink a ticket to a test case

hashtagGet a list of distinct tests that failed in the given time range

hashtagGet a list of unhealthy tests

hashtagGet a list of quarantined tests

Get the details of a test case

Link a ticket to a test case

Get a list of distinct tests that failed in the given time range

Get a list of unhealthy tests

Get a list of quarantined tests