Fail the first N attempts for a key, then succeed

GETPOSThttps://api.testingapis.com/api/chaos/retry/{key}Sign in to see this endpoint's URL

A deterministic way to test retry logic: with succeedAfter=3, attempts 1-3 fail and attempt 4 succeeds. Every response has an X-Attempt header, and failures add Retry-After: 1. Reset the counter with DELETE /api/chaos/retry/{key}. Available for GET and POST.A deterministic way to test retry logic: with succeedAfter=3, attempts 1-3 fail and attempt 4 succeeds. Every response has an X-Attempt header, and failures add Retry-After: 1. Reset the counter with DELETE …. Available for GET and POST.

Parameters 3

Name	Type	Description
`key`required	path · string	Your own counter name (up to 64 characters). Each key counts attempts independently.
`succeedAfter`	query · integer (int32)	Number of attempts that fail before success (0-20, default 3). Default: 3.
`failStatus`	query · integer (int32)	Status used for failures: 429, 500, 502, 503 or 504 (default 503). Default: 503.

Responses

200: This attempt succeeded.
400: Invalid key, succeedAfter or failStatus.
503: This attempt failed (or the chosen failStatus).

Example

Request

curl -X GET "https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0" \
  -H "X-TestingApis-Key: YOUR_API_KEY"

Response200 OK

{"message": "Succeeded on attempt 1.", "attempt": 1, "succeedAfter": 0}

The parameters, request and response examples and the live Try it panel for this endpoint are for signed-in members. Accounts are free and take a few seconds to create.

Try itSign-in requiredUses your key

api.testingapis.com

curl 'https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0' \
  -H 'X-TestingApis-Key: YOUR_API_KEY'

const res = await fetch("https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0", {
  headers: {
    "X-TestingApis-Key": "YOUR_API_KEY",
  },
});
console.log(res.status, await res.text());

// The shape of the example response in the docs.
type ApiResponse = {
  message: string;
  attempt: number;
  succeedAfter: number;
};

const res = await fetch("https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0", {
  headers: {
    "X-TestingApis-Key": "YOUR_API_KEY",
  },
});
const body = (await res.json()) as ApiResponse;
console.log(res.status, body);

import requests

res = requests.get(
    "https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0",
    headers={
        "X-TestingApis-Key": "YOUR_API_KEY",
    },
)
print(res.status_code, res.text)

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0");
request.Headers.TryAddWithoutValidation("X-TestingApis-Key", "YOUR_API_KEY");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0"))
                .header("X-TestingApis-Key", "YOUR_API_KEY")
                .GET()
                .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-TestingApis-Key", "YOUR_API_KEY")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.StatusCode, string(data))
}

https://api.testingapis.com/api/chaos/retry/docs-demo?succeedAfter=0

Path

keyrequiredstring

Query

succeedAfterinteger (int32)

failStatusinteger (int32)

Headers

These endpoints fail or stall on purpose, some for up to 60 seconds. Use Cancel to stop waiting.