HTTPBin API Reference — 73 Endpoints

Anything 2 endpoints

GET /anything Returns anything passed in request data.

operationId: Anything_getData

Responses

200 Anything passed in request

GET /anything

GET /anything/{anything} Returns anything passed in request data.

operationId: Anything_getData

Responses

200 Anything passed in request

GET /anything/{anything}

Auth 6 endpoints

GET /basic-auth/{user}/{passwd} Prompts the user for authorization using HTTP Basic Auth.

operationId: Auth_promptAuthorizationUsingHttpGet

Parameters

Name	In	Required	Type	Description
user	path	required	string
passwd	path	required	string

Responses

200 Sucessful authentication.

401 Unsuccessful authentication.

GET /basic-auth/{user}/{passwd}

GET /bearer Prompts the user for authorization using bearer authentication.

operationId: Auth_promptAuthorization

Parameters

Name	In	Required	Type	Description
Authorization	header	optional	string

Responses

200 Sucessful authentication.

401 Unsuccessful authentication.

GET /bearer

GET /digest-auth/{qop}/{user}/{passwd} Prompts the user for authorization using Digest Auth.

operationId: Auth_digestAuthPrompt

Parameters

Name	In	Required	Type	Description
qop	path	required	string	auth or auth-int
user	path	required	string
passwd	path	required	string

Responses

200 Sucessful authentication.

401 Unsuccessful authentication.

GET /digest-auth/{qop}/{user}/{passwd}

GET /digest-auth/{qop}/{user}/{passwd}/{algorithm} Prompts the user for authorization using Digest Auth + Algorithm.

operationId: Auth_userAuthorizationDigest

Parameters

Name	In	Required	Type	Description
qop	path	required	string	auth or auth-int
user	path	required	string
passwd	path	required	string
algorithm	path	required	string	MD5, SHA-256, SHA-512

Responses

200 Sucessful authentication.

401 Unsuccessful authentication.

GET /digest-auth/{qop}/{user}/{passwd}/{algorithm}

GET /digest-auth/{qop}/{user}/{passwd}/{algorithm}/{stale_after} Prompts the user for authorization using Digest Auth + Algorithm.

allow settings the stale_after argument.

operationId: Auth_promptAuthorizationUsingDigest

Parameters

Name	In	Required	Type	Description
qop	path	required	string	auth or auth-int
user	path	required	string
passwd	path	required	string
algorithm	path	required	string	MD5, SHA-256, SHA-512
stale_after	path	required	string

Responses

200 Sucessful authentication.

401 Unsuccessful authentication.

GET /digest-auth/{qop}/{user}/{passwd}/{algorithm}/{stale_after}

GET /hidden-basic-auth/{user}/{passwd} Prompts the user for authorization using HTTP Basic Auth.

operationId: Auth_promptUserAuthorization

Parameters

Name	In	Required	Type	Description
user	path	required	string
passwd	path	required	string

Responses

200 Sucessful authentication.

404 Unsuccessful authentication.

GET /hidden-basic-auth/{user}/{passwd}

Cookies 4 endpoints

GET /cookies Returns cookie data.

operationId: Cookies_getData

Responses

200 Set cookies.

GET /cookies

GET /cookies/delete Deletes cookie(s) as provided by the query string and redirects to cookie list.

operationId: Cookies_deleteRedirectToCookieList

Parameters

Name	In	Required	Type	Description
freeform	query	optional	string

Responses

200 Redirect to cookie list

GET /cookies/delete

GET /cookies/set Sets cookie(s) as provided by the query string and redirects to cookie list.

operationId: Cookies_setRedirect

Parameters

Name	In	Required	Type	Description
freeform	query	optional	string

Responses

200 Redirect to cookie list

GET /cookies/set

GET /cookies/set/{name}/{value} Sets a cookie and redirects to cookie list.

operationId: Cookies_setCookieRedirect

Parameters

Name	In	Required	Type	Description
name	path	required	string
value	path	required	string

Responses

200 Set cookies and redirects to cookie list.

GET /cookies/set/{name}/{value}

Dynamic data 9 endpoints

GET /base64/{value} Decodes base64url-encoded string.

operationId: DynamicData_decodeBase64urlString

Parameters

Name	In	Required	Type	Description
value	path	required	string

Responses

200 Decoded base64 content.

GET /base64/{value}

GET /bytes/{n} Returns n random bytes generated with given seed

operationId: DynamicData_getRandomBytes

Parameters

Name	In	Required	Type	Description
n	path	required	int

Responses

200 Bytes.

GET /bytes/{n}

GET /delay/{delay} Returns a delayed response (max of 10 seconds).

operationId: DynamicData_delayedResponseGet

Parameters

Name	In	Required	Type	Description
delay	path	required	int

Responses

200 A delayed response.

GET /delay/{delay}

GET /drip Drips data over a duration after an optional initial delay.

operationId: DynamicData_dripDataOverDuration

Parameters

Name	In	Required	Type	Description
duration	query	optional	number	The amount of time (in seconds) over which to drip each byte
numbytes	query	optional	integer	The number of bytes to respond with
code	query	optional	integer	The response code that will be returned
delay	query	optional	number	The amount of time (in seconds) to delay before responding

Responses

200 A dripped response.

GET /drip

GET /links/{n}/{offset} Generate a page containing n links to other pages which do the same.

operationId: DynamicData_generatePageContainingLinks

Parameters

Name	In	Required	Type	Description
n	path	required	int
offset	path	required	int

Responses

200 HTML links.

GET /links/{n}/{offset}

GET /range/{numbytes} Streams n random bytes generated with given seed, at given chunk size per packet.

operationId: DynamicData_streamRandomBytes

Parameters

Name	In	Required	Type	Description
numbytes	path	required	int

Responses

200 Bytes.

GET /range/{numbytes}

GET /stream-bytes/{n} Streams n random bytes generated with given seed, at given chunk size per packet.

operationId: DynamicData_streamRandomBytes

Parameters

Name	In	Required	Type	Description
n	path	required	int

Responses

200 Bytes.

GET /stream-bytes/{n}

GET /stream/{n} Stream n JSON responses

operationId: DynamicData_streamJsonResponses

Parameters

Name	In	Required	Type	Description
n	path	required	int

Responses

200 Streamed JSON responses.

GET /stream/{n}

GET /uuid Return a UUID4.

operationId: DynamicData_generateUuid

Responses

200 A UUID4.

GET /uuid

Http methods 1 endpoints

GET /get The request's query parameters.

operationId: HttpMethods_requestQueryParametersGet

Responses

200 The request's query parameters.

GET /get

Images 5 endpoints

GET /image Returns a simple image of the type suggest by the Accept header.

operationId: Images_getByAcceptHeader

Responses

200 An image.

GET /image

GET /image/jpeg Returns a simple JPEG image.

operationId: Images_getJpegImage

Responses

200 A JPEG image.

GET /image/jpeg

GET /image/png Returns a simple PNG image.

operationId: Images_getPngImage

Responses

200 A PNG image.

GET /image/png

GET /image/svg Returns a simple SVG image.

operationId: Images_getSvgImage

Responses

200 An SVG image.

GET /image/svg

GET /image/webp Returns a simple WEBP image.

operationId: Images_getWebpImage

Responses

200 A WEBP image.

GET /image/webp

Redirects 4 endpoints

GET /absolute-redirect/{n} Absolutely 302 Redirects n times.

operationId: Redirects_absolutelyRedirectsN

Parameters

Name	In	Required	Type	Description
n	path	required	int

Responses

default A redirection.

GET /absolute-redirect/{n}

GET /redirect-to 302/3XX Redirects to the given URL.

operationId: Redirects_toGivenUrlGet

Parameters

Name	In	Required	Type	Description
url	query	required	string
status_code	query	optional	int

Responses

default A redirection.

GET /redirect-to

GET /redirect/{n} 302 Redirects n times.

operationId: Redirects_302RedirectsN

Parameters

Name	In	Required	Type	Description
n	path	required	int

Responses

default A redirection.

GET /redirect/{n}

GET /relative-redirect/{n} Relatively 302 Redirects n times.

operationId: Redirects_relatively302RedirectsN

Parameters

Name	In	Required	Type	Description
n	path	required	int

Responses

default A redirection.

GET /relative-redirect/{n}

Request inspection 3 endpoints

GET /headers Return the incoming request's HTTP headers.

operationId: RequestInspection_incomingHeadersGet

Responses

200 The request's headers.

GET /headers

GET /ip Returns the requester's IP Address.

operationId: RequestInspection_ipAddressGet

Responses

200 The Requester's IP Address.

GET /ip

GET /user-agent Return the incoming requests's User-Agent header.

operationId: RequestInspection_userAgentGet

Responses

200 The request's User-Agent header.

GET /user-agent

Response formats 9 endpoints

GET /brotli Returns Brotli-encoded data.

operationId: ResponseFormats_brotliGetData

Responses

200 Brotli-encoded data.

GET /brotli

GET /deflate Returns Deflate-encoded data.

operationId: ResponseFormats_deflateDataGet

Responses

200 Defalte-encoded data.

GET /deflate

GET /deny Returns page denied by robots.txt rules.

operationId: ResponseFormats_deniedPageGet

Responses

200 Denied message

GET /deny

GET /encoding/utf8 Returns a UTF-8 encoded body.

operationId: ResponseFormats_utf8BodyGet

Responses

200 Encoded UTF-8 content.

GET /encoding/utf8

GET /gzip Returns GZip-encoded data.

operationId: ResponseFormats_gzipDataGet

Responses

200 GZip-encoded data.

GET /gzip

GET /html Returns a simple HTML document.

operationId: ResponseFormats_simpleHtmlGet

Responses

200 An HTML page.

GET /html

GET /json Returns a simple JSON document.

operationId: ResponseFormats_simpleJsonGet

Responses

200 An JSON document.

GET /json

GET /robots.txt Returns some robots.txt rules.

operationId: ResponseFormats_getRobotsRules

Responses

200 Robots file

GET /robots.txt

GET /xml Returns a simple XML document.

operationId: ResponseFormats_simpleXmlGet

Responses

200 An XML document.

GET /xml

Response inspection 4 endpoints

GET /cache Returns a 304 if an If-Modified-Since header or If-None-Match is present. Returns the same as a GET otherwise.

operationId: ResponseInspection_notModifiedGet

Parameters

Name	In	Required	Type	Description
If-Modified-Since	header	optional	string
If-None-Match	header	optional	string

Responses

200 Cached response

304 Modified

GET /cache

GET /cache/{value} Sets a Cache-Control header for n seconds.

operationId: ResponseInspection_cacheControlSet

Parameters

Name	In	Required	Type	Description
value	path	required	integer

Responses

200 Cache control set

GET /cache/{value}

GET /etag/{etag} Assumes the resource has the given etag and responds to If-None-Match and If-Match headers appropriately.

operationId: ResponseInspection_resourceInspectionGet

Parameters

Name	In	Required	Type	Description
If-None-Match	header	optional	string
If-Match	header	optional	string

Responses

200 Normal response

412 match

GET /etag/{etag}

GET /response-headers Returns a set of response headers from the query string.

operationId: ResponseInspection_queryHeadersGet

Parameters

Name	In	Required	Type	Description
freeform	query	optional	string

Responses

200 Response headers

GET /response-headers

Status codes 1 endpoints

GET /status/{codes} Return status code or random status code if more than one are given

operationId: StatusCodes_returnRandomCode

Parameters

Name	In	Required	Type	Description
codes	path	required	string

Responses

100 Informational responses

200 Success

300 Redirection

400 Client Errors

500 Server Errors

GET /status/{codes}

HTTPBin

Server URLs

Endpoints

Anything 2 endpoints

Responses

Responses

Auth 6 endpoints

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Cookies 4 endpoints

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Dynamic data 9 endpoints

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Responses

Http methods 1 endpoints

Responses

Images 5 endpoints

Responses

Responses

Responses

Responses

Responses

Redirects 4 endpoints

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Request inspection 3 endpoints

Responses

Responses

Responses

Response formats 9 endpoints

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Response inspection 4 endpoints

Parameters

Responses

Parameters