Authenticate with an API key in the X-API-Key header

GEThttps://api.testingapis.com/api/auth/api-key/headerSign in to see this endpoint's URL

Header: X-API-Key: apibee-key-123.

API key header X-API-Key: apibee-key-123

Responses

200: Authenticated.
401: No key sent, or the key is wrong.

Example

Request

curl -X GET "https://api.testingapis.com/api/auth/api-key/header" \
  -H "X-API-Key: apibee-key-123" \
  -H "X-TestingApis-Key: YOUR_API_KEY"

Response200 OK

{"authenticated": true, "scheme": "api-key", "location": "X-API-Key header"}

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/auth/api-key/header' \
  -H 'X-API-Key: apibee-key-123' \
  -H 'X-TestingApis-Key: YOUR_API_KEY'

const res = await fetch("https://api.testingapis.com/api/auth/api-key/header", {
  headers: {
    "X-API-Key": "apibee-key-123",
    "X-TestingApis-Key": "YOUR_API_KEY",
  },
});
console.log(res.status, await res.text());

// The shape of the example response in the docs.
type ApiResponse = {
  authenticated: boolean;
  scheme: string;
  location: string;
};

const res = await fetch("https://api.testingapis.com/api/auth/api-key/header", {
  headers: {
    "X-API-Key": "apibee-key-123",
    "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/auth/api-key/header",
    headers={
        "X-API-Key": "apibee-key-123",
        "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/auth/api-key/header");
request.Headers.TryAddWithoutValidation("X-API-Key", "apibee-key-123");
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/auth/api-key/header"))
                .header("X-API-Key", "apibee-key-123")
                .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/auth/api-key/header", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", "apibee-key-123")
	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))
}