httpbin

https://github.com/postmanlabs/httpbin
Admin
httpbin is a simple HTTP Request & Response Service, written in Python + Flask, used for testing...
Tokens:62,143
Snippets:388
Trust Score:10
License:ISC
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install httpbin and run with Gunicorn

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Install httpbin from PyPI and run it as a WSGI app using Gunicorn. Execute these commands in a terminal.

```bash
$ pip install httpbin
$ gunicorn httpbin:app
```

--------------------------------

### GET /get

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns GET request data.

```APIDOC
## [GET] /get

### Description
Returns GET request data.

### Method
GET

### Endpoint
/get

### Parameters
#### Query Parameters
- **any** (string) - Optional - Any query parameters are echoed back.

### Response
#### Success Response (200)
- **args** (object) - Query parameters.
- **headers** (object) - Request headers.
- **origin** (string) - Requester's IP.
- **url** (string) - Full request URL.

#### Response Example
```json
{
  "args": {},
  "headers": {},
  "origin": "127.0.0.1",
  "url": "http://httpbin.org/get"
}
```
```

--------------------------------

### GET /xml

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns an XML document.

```APIDOC
## [GET] /xml

### Description
Returns an XML document.

### Method
GET

### Endpoint
/xml

### Response
#### Success Response (200)
- **body** (application/xml) - The XML document.
```

--------------------------------

### GET /json

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns a JSON document.

```APIDOC
## [GET] /json

### Description
Returns a JSON document.

### Method
GET

### Endpoint
/json

### Response
#### Success Response (200)
- **body** (application/json) - The JSON document.
```

--------------------------------

### GET /robots.txt

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns the robots.txt file.

```APIDOC
## [GET] /robots.txt

### Description
Returns the robots.txt file.

### Method
GET

### Endpoint
/robots.txt

### Response
#### Success Response (200)
- **body** (text/plain) - The robots.txt content.

#### Response Example
```
User-agent: *
Disallow: /deny
```
```

--------------------------------

### GET /html

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns a simple HTML document.

```APIDOC
## [GET] /html

### Description
Returns a simple HTML document.

### Method
GET

### Endpoint
/html

### Response
#### Success Response (200)
- **body** (text/html) - The HTML document.

#### Response Example
```html
<!DOCTYPE html>
<html>...</html>
```
```

--------------------------------

### Usage example as a decorator

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/filters.md

Example of applying the gzip decorator to a Flask route. The response arrives with Content-Encoding: gzip and a re-computed Content-Length.

```python
from flask import jsonify
from httpbin import filters

@app.route("/compressed-data")
@filters.gzip
def compressed_data():
    return jsonify(payload="large-response")
# response arrives with Content-Encoding: gzip and a re-computed Content-Length
```

--------------------------------

### GET /headers

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns the request headers.

```APIDOC
## [GET] /headers

### Description
Returns the request headers.

### Method
GET

### Endpoint
/headers

### Response
#### Success Response (200)
- **headers** (object) - The request headers.

#### Response Example
```json
{
  "headers": {
    "Host": "httpbin.org",
    "User-Agent": "curl/7.68.0"
  }
}
```
```

--------------------------------

### GET /deny

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns a denial page.

```APIDOC
## [GET] /deny

### Description
Returns a denial page.

### Method
GET

### Endpoint
/deny

### Response
#### Success Response (200)
- **body** (text/html) - The denial page HTML.

#### Response Example
```html
<!DOCTYPE html>
<html>...</html>
```
```

--------------------------------

### GET /drip

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Drips data over a duration.

```APIDOC
## [GET] /drip

### Description
Drips data over a duration.

### Method
GET

### Endpoint
/drip

### Parameters
#### Query Parameters
- **duration** (number) - Optional - Duration in seconds.
- **numbytes** (integer) - Optional - Number of bytes to drip.
- **delay** (number) - Optional - Initial delay in seconds.
- **code** (integer) - Optional - HTTP status code.

### Response
#### Success Response (200)
- **body** (application/octet-stream) - The dripped data.
```

--------------------------------

### GET /cache

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns a cached response.

```APIDOC
## [GET] /cache

### Description
Returns a cached response.

### Method
GET

### Endpoint
/cache

### Response
#### Success Response (200)
- **body** (text/plain) - The cached response.
```

--------------------------------

### GET /legacy

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Serves the legacy landing page. Returns an HTML page.

```APIDOC
## [GET] /legacy

### Description
Serves the legacy landing page. Returns an HTML page.

### Method
GET

### Endpoint
/legacy

### Response
#### Success Response (200)
- **body** (text/html) - The legacy landing page HTML.

#### Response Example
```html
<!DOCTYPE html>
<html>...</html>
```
```

--------------------------------

### GET /etag/<etag>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns an ETag header.

```APIDOC
## [GET] /etag/<etag>

### Description
Returns an ETag header.

### Method
GET

### Endpoint
/etag/<etag>

### Parameters
#### Path Parameters
- **etag** (string) - Required - The ETag value.

### Response
#### Success Response (200)
- **ETag** (string) - The ETag header.
```

--------------------------------

### GET /basic-auth/<user>/<passwd>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Performs HTTP Basic Auth.

```APIDOC
## [GET] /basic-auth/<user>/<passwd>

### Description
Performs HTTP Basic Auth.

### Method
GET

### Endpoint
/basic-auth/<user>/<passwd>

### Parameters
#### Path Parameters
- **user** (string) - Required - The username.
- **passwd** (string) - Required - The password.

### Response
#### Success Response (200)
- **authenticated** (boolean) - True if authenticated.
- **user** (string) - The username.

#### Response Example
```json
{
  "authenticated": true,
  "user": "user"
}
```

#### Error Response (401)
- **body** (text/plain) - Unauthorized message.
```

--------------------------------

### GET /bearer

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Performs Bearer Auth.

```APIDOC
## [GET] /bearer

### Description
Performs Bearer Auth.

### Method
GET

### Endpoint
/bearer

### Response
#### Success Response (200)
- **authenticated** (boolean) - True if authenticated.
- **token** (string) - The bearer token.

#### Response Example
```json
{
  "authenticated": true,
  "token": "mytoken"
}
```

#### Error Response (401)
- **body** (text/plain) - Unauthorized message.
```

--------------------------------

### GET /uuid

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns a UUID4.

```APIDOC
## [GET] /uuid

### Description
Returns a UUID4.

### Method
GET

### Endpoint
/uuid

### Response
#### Success Response (200)
- **uuid** (string) - A UUID4 string.

#### Response Example
```json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}
```
```

--------------------------------

### GET /

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Returns the landing page of the httpbin service.

```APIDOC
## [GET] /

### Description
Returns the landing page of the httpbin service.

### Method
GET

### Endpoint
/
```

--------------------------------

### GET /redirect/<int:n>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Redirects n times.

```APIDOC
## [GET] /redirect/<int:n>

### Description
Redirects n times.

### Method
GET

### Endpoint
/redirect/<int:n>

### Parameters
#### Path Parameters
- **n** (integer) - Required - Number of redirects.

### Response
#### Success Response (302)
- **Location** (string) - The next redirect URL.

#### Response Example
```
HTTP/1.1 302 Found
Location: /relative-redirect/1
```
```

--------------------------------

### GET /image/webp

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a WebP image.

```APIDOC
## GET /image/webp

### Description
Returns a WebP image.

### Method
GET

### Endpoint
/image/webp

### Response
#### Success Response (200)
Returns a WebP image with Content-Type: image/webp.
```

--------------------------------

### status_code usage example

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/helpers.md

Shows how to call status_code with 418 and print the response data and x-more-info header. The data is the ASCII teapot art.

```python
from httpbin.helpers import status_code

r = status_code(418)
print(r.data)   # "    -=[ teapot ]=- ..." (ASCII teapot)
print(r.headers["x-more-info"])
```

--------------------------------

### GET /deny

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Denied by robots.txt file.

```APIDOC
## [GET] /deny

### Description
Denied by robots.txt file.

### Method
GET

### Endpoint
/deny
```

--------------------------------

### GET /legacy

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns the legacy index HTML page.

```APIDOC
## GET /legacy

### Description
Returns the legacy index HTML page.

### Method
GET

### Endpoint
`/legacy`

### Response
#### Success Response (200)
- **body** (HTML) - Rendered index.html

#### Response Example
```html
<!DOCTYPE html>
<html>...</html>
```
```

--------------------------------

### GET /anything

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Returns request data, including the method used.

```APIDOC
## [GET] /anything

### Description
Returns request data, including the method used.

### Method
GET

### Endpoint
/anything
```

--------------------------------

### GET /bytes/<int:n>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns n random bytes.

```APIDOC
## [GET] /bytes/<int:n>

### Description
Returns n random bytes.

### Method
GET

### Endpoint
/bytes/<int:n>

### Parameters
#### Path Parameters
- **n** (integer) - Required - Number of bytes.

### Response
#### Success Response (200)
- **body** (application/octet-stream) - The random bytes.
```

--------------------------------

### GET /links/<int:n>/<int:offset>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns a page with links to other pages.

```APIDOC
## [GET] /links/<int:n>/<int:offset>

### Description
Returns a page with links to other pages.

### Method
GET

### Endpoint
/links/<int:n>/<int:offset>

### Parameters
#### Path Parameters
- **n** (integer) - Required - Total number of pages.
- **offset** (integer) - Required - Current page offset.

### Response
#### Success Response (200)
- **body** (text/html) - The HTML page with links.
```

--------------------------------

### GET /image/png

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a PNG image.

```APIDOC
## GET /image/png

### Description
Returns a PNG image.

### Method
GET

### Endpoint
/image/png

### Response
#### Success Response (200)
Returns a PNG image with Content-Type: image/png.
```

--------------------------------

### GET /range/<int:numbytes>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns a range of bytes.

```APIDOC
## [GET] /range/<int:numbytes>

### Description
Returns a range of bytes.

### Method
GET

### Endpoint
/range/<int:numbytes>

### Parameters
#### Path Parameters
- **numbytes** (integer) - Required - Number of bytes.

### Response
#### Success Response (200)
- **body** (application/octet-stream) - The range of bytes.
```

--------------------------------

### GET /xml

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a sample XML document with Content-Type: application/xml.

```APIDOC
## GET /xml

### Description
Returns a sample XML document with Content-Type: application/xml.

### Method
GET

### Endpoint
`/xml`

### Response
#### Success Response (200)
- **body** (XML) - Sample XML content

#### Response Example
```xml
<sample>...</sample>
```
```

--------------------------------

### GET /anything/:anything

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Returns request data, including the URL.

```APIDOC
## [GET] /anything/:anything

### Description
Returns request data, including the URL.

### Method
GET

### Endpoint
/anything/:anything

### Parameters
#### Path Parameters
- **anything** (string) - Required - The path parameter to echo back.
```

--------------------------------

### GET /absolute-redirect/<int:n>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Redirects n times to absolute URLs.

```APIDOC
## [GET] /absolute-redirect/<int:n>

### Description
Redirects n times to absolute URLs.

### Method
GET

### Endpoint
/absolute-redirect/<int:n>

### Parameters
#### Path Parameters
- **n** (integer) - Required - Number of redirects.

### Response
#### Success Response (302)
- **Location** (string) - The next absolute redirect URL.

#### Response Example
```
HTTP/1.1 302 Found
Location: http://httpbin.org/absolute-redirect/1
```
```

--------------------------------

### GET /redirect-to

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

302 Redirects to the given URL.

```APIDOC
## [GET] /redirect-to

### Description
302 Redirects to the given URL.

### Method
GET

### Endpoint
/redirect-to

### Parameters
#### Query Parameters
- **url** (string) - Required - The URL to redirect to.
- **status_code** (integer) - Optional - The HTTP status code to use for the redirect (e.g., 307).
```

--------------------------------

### GET /cookies

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns the cookies sent by the client.

```APIDOC
## [GET] /cookies

### Description
Returns the cookies sent by the client.

### Method
GET

### Endpoint
/cookies

### Response
#### Success Response (200)
- **cookies** (object) - The cookies.

#### Response Example
```json
{
  "cookies": {
    "session": "abc123"
  }
}
```
```

--------------------------------

### GET /base64/<value>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Decodes a base64-encoded value.

```APIDOC
## [GET] /base64/<value>

### Description
Decodes a base64-encoded value.

### Method
GET

### Endpoint
/base64/<value>

### Parameters
#### Path Parameters
- **value** (string) - Required - The base64-encoded value.

### Response
#### Success Response (200)
- **body** (text/plain) - The decoded value.
```

--------------------------------

### GET /cache/<int:value>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Sets Cache-Control header.

```APIDOC
## [GET] /cache/<int:value>

### Description
Sets Cache-Control header.

### Method
GET

### Endpoint
/cache/<int:value>

### Parameters
#### Path Parameters
- **value** (integer) - Required - The max-age value in seconds.

### Response
#### Success Response (200)
- **Cache-Control** (string) - The cache control header.
```

--------------------------------

### GET /json

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a fixed slideshow JSON document.

```APIDOC
## GET /json

### Description
Returns a fixed slideshow JSON document.

### Method
GET

### Endpoint
`/json`

### Response
#### Success Response (200)
- **body** (JSON) - Slideshow JSON

#### Response Example
```json
{
  "slideshow": {}
}
```
```

--------------------------------

### GET /forms/post

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns an HTML form that posts to /post.

```APIDOC
## GET /forms/post

### Description
Returns an HTML form that posts to /post.

### Method
GET

### Endpoint
/forms/post

### Response
#### Success Response (200)
Returns an HTML form.
```

--------------------------------

### GET /cookies/set

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Sets cookies from query parameters and redirects to /cookies.

```APIDOC
## [GET] /cookies/set

### Description
Sets cookies from query parameters and redirects to /cookies.

### Method
GET

### Endpoint
/cookies/set

### Parameters
#### Query Parameters
- **any** (string) - Optional - Each query parameter is set as a cookie.

### Response
#### Success Response (302)
- **Location** (string) - Redirect to /cookies.
- **Set-Cookie** (string) - The cookies to set.

#### Response Example
```
HTTP/1.1 302 Found
Location: /cookies
Set-Cookie: name=value; Path=/
```
```

--------------------------------

### GET /relative-redirect/<int:n>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Redirects n times relative to the current path.

```APIDOC
## [GET] /relative-redirect/<int:n>

### Description
Redirects n times relative to the current path.

### Method
GET

### Endpoint
/relative-redirect/<int:n>

### Parameters
#### Path Parameters
- **n** (integer) - Required - Number of redirects.

### Response
#### Success Response (302)
- **Location** (string) - The next relative redirect URL.

#### Response Example
```
HTTP/1.1 302 Found
Location: /relative-redirect/1
```
```

--------------------------------

### GET /redirect/:n

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

302 Redirects n times.

```APIDOC
## [GET] /redirect/:n

### Description
302 Redirects n times.

### Method
GET

### Endpoint
/redirect/:n

### Parameters
#### Path Parameters
- **n** (integer) - Required - The number of redirects to perform.
```

--------------------------------

### GET /cookies/set/<name>/<value>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Sets a cookie and redirects to /cookies.

```APIDOC
## [GET] /cookies/set/<name>/<value>

### Description
Sets a cookie and redirects to /cookies.

### Method
GET

### Endpoint
/cookies/set/<name>/<value>

### Parameters
#### Path Parameters
- **name** (string) - Required - The cookie name.
- **value** (string) - Required - The cookie value.

### Response
#### Success Response (302)
- **Location** (string) - Redirect to /cookies.
- **Set-Cookie** (string) - The cookie to set.

#### Response Example
```
HTTP/1.1 302 Found
Location: /cookies
Set-Cookie: name=value; Path=/
```
```

--------------------------------

### GET /stream/<int:n>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Streams n JSON lines.

```APIDOC
## [GET] /stream/<int:n>

### Description
Streams n JSON lines.

### Method
GET

### Endpoint
/stream/<int:n>

### Parameters
#### Path Parameters
- **n** (integer) - Required - Number of lines to stream.

### Response
#### Success Response (200)
- **body** (application/json) - A stream of JSON objects.

#### Response Example
```json
{"id": 0}
{"id": 1}
```
```

--------------------------------

### GET /user-agent

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns the User-Agent header from the request.

```APIDOC
## [GET] /user-agent

### Description
Returns the User-Agent header from the request.

### Method
GET

### Endpoint
/user-agent

### Response
#### Success Response (200)
- **user-agent** (string) - The User-Agent header value.

#### Response Example
{
  "user-agent": "<User-Agent header>"
}
```

--------------------------------

### GET /html

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a rendered HTML page from the moby template.

```APIDOC
## GET /html

### Description
Returns a rendered HTML page from the moby template.

### Method
GET

### Endpoint
`/html`

### Response
#### Success Response (200)
- **body** (HTML) - Rendered HTML content

#### Response Example
```html
<!DOCTYPE html>
<html>...</html>
```
```

--------------------------------

### GET /response-headers

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Returns the given response headers.

```APIDOC
## [GET] /response-headers

### Description
Returns the given response headers.

### Method
GET

### Endpoint
/response-headers

### Parameters
#### Query Parameters
- **key** (string) - Optional - The header name and value to include in the response, e.g., `?key=val`.
```

--------------------------------

### GET /deny

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a fixed angry ASCII art text.

```APIDOC
## GET /deny

### Description
Returns a fixed angry ASCII art text.

### Method
GET

### Endpoint
`/deny`

### Response
#### Success Response (200)
- **body** (text) - ANGRY_ASCII content

#### Response Example
```
(angry ASCII art)
```
```

--------------------------------

### GET /ip

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns the requester's IP address.

```APIDOC
## [GET] /ip

### Description
Returns the requester's IP address.

### Method
GET

### Endpoint
/ip

### Response
#### Success Response (200)
- **origin** (string) - The requester's IP address.

#### Response Example
```json
{
  "origin": "127.0.0.1"
}
```
```

--------------------------------

### GET /links/{n}/{offset}

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Renders an HTML page with n links to sibling pages, highlighting the current offset.

```APIDOC
## GET /links/{n}/{offset}

### Description
Renders an HTML page with n links to sibling pages, highlighting the current offset.

### Method
GET

### Endpoint
`/links/{n}/{offset}`

### Parameters
#### Path Parameters
- **n** (int) - Required - Number of links, clamped to [1, 200].
- **offset** (int) - Required - Current page offset.

### Response
#### Success Response (200)
- **body** (HTML) - Page with links

#### Response Example
```html
<!DOCTYPE html>
<html>...</html>
```
```

--------------------------------

### GET /stream/:n

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Streams min(n, 100) lines.

```APIDOC
## [GET] /stream/:n

### Description
Streams min(n, 100) lines.

### Method
GET

### Endpoint
/stream/:n

### Parameters
#### Path Parameters
- **n** (integer) - Required - The number of lines to stream.
```

--------------------------------

### GET /robots.txt

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns the robots.txt content with a disallow rule for /deny.

```APIDOC
## GET /robots.txt

### Description
Returns the robots.txt content with a disallow rule for /deny.

### Method
GET

### Endpoint
`/robots.txt`

### Response
#### Success Response (200)
- **body** (text) - `User-agent: *\nDisallow: /deny`

#### Response Example
```
User-agent: *
Disallow: /deny
```
```

--------------------------------

### GET /links/:n

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Returns a page containing n HTML links.

```APIDOC
## GET /links/:n

### Description
Returns a page containing n HTML links.

### Method
GET

### Endpoint
/links/:n

### Parameters
#### Path Parameters
- **n** (integer) - Required - Number of HTML links to include in the page.

```

--------------------------------

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

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/errors.md

Performs Digest authentication. Returns 401 with digest challenge and cookies on failure.

```APIDOC
## [GET] /digest-auth/{qop}/{user}/{passwd}

### Description
Performs Digest authentication. Returns 401 with digest challenge and cookies on failure.

### Method
GET

### Endpoint
/digest-auth/{qop}/{user}/{passwd}

### Parameters
#### Path Parameters
- **qop** (string) - Required - Quality of protection (auth or auth-int).
- **user** (string) - Required - Username.
- **passwd** (string) - Required - Password.

#### Query Parameters
- **require-cookie** (boolean) - Optional - If true, requires a cookie to be set.

### Response
#### Error Response (401)
- **headers** - Digest challenge
- **cookies** - `stale_after`, `fake`, `last_nonce`
- **body** - empty
```

--------------------------------

### GET /etag/<etag>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Simulates a resource with the given ETag, honoring If-None-Match and If-Match headers.

```APIDOC
## [GET] /etag/<etag>

### Description
Simulates a resource with the given ETag, honoring If-None-Match and If-Match headers.

### Method
GET

### Endpoint
/etag/<etag>

### Parameters
#### Path Parameters
- **etag** (string) - Required - The ETag value to simulate.

### Response
#### Success Response (200)
- **body** (object) - The /get payload with `ETag: <etag>` header.

#### Success Response (304)
- Empty body, `ETag: <etag>` header retained.

#### Error Response (412)
- Empty body.

### Notes
- If `If-None-Match` present and contains `etag` or `*`, returns 304.
- If `If-Match` present and does not contain `etag` or `*`, returns 412.
- Otherwise returns 200.
```

--------------------------------

### GET /stream-bytes/<int:n>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Streams n random bytes.

```APIDOC
## [GET] /stream-bytes/<int:n>

### Description
Streams n random bytes.

### Method
GET

### Endpoint
/stream-bytes/<int:n>

### Parameters
#### Path Parameters
- **n** (integer) - Required - Number of bytes to stream.

### Response
#### Success Response (200)
- **body** (application/octet-stream) - The streamed bytes.
```

--------------------------------

### GET /hidden-basic-auth/<user>/<passwd>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Performs HTTP Basic Auth with a hidden challenge.

```APIDOC
## [GET] /hidden-basic-auth/<user>/<passwd>

### Description
Performs HTTP Basic Auth with a hidden challenge.

### Method
GET

### Endpoint
/hidden-basic-auth/<user>/<passwd>

### Parameters
#### Path Parameters
- **user** (string) - Required - The username.
- **passwd** (string) - Required - The password.

### Response
#### Success Response (200)
- **authenticated** (boolean) - True if authenticated.
- **user** (string) - The username.

#### Response Example
```json
{
  "authenticated": true,
  "user": "user"
}
```

#### Error Response (404)
- **body** (text/plain) - Not found if authentication fails.
```

--------------------------------

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

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/errors.md

Performs Basic authentication. Returns 401 with WWW-Authenticate header if credentials are missing or wrong.

```APIDOC
## [GET] /basic-auth/{user}/{passwd}

### Description
Performs Basic authentication. Returns 401 with WWW-Authenticate header if credentials are missing or wrong.

### Method
GET

### Endpoint
/basic-auth/{user}/{passwd}

### Parameters
#### Path Parameters
- **user** (string) - Required - Username for authentication.
- **passwd** (string) - Required - Password for authentication.

### Response
#### Error Response (401)
- **headers** - `WWW-Authenticate: Basic realm="Fake Realm"`
- **body** - empty
```

--------------------------------

### GET /links/{n}

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Redirects to a page with n links to sibling pages.

```APIDOC
## GET /links/{n}

### Description
Redirects to a page with n links to sibling pages.

### Method
GET

### Endpoint
`/links/{n}`

### Parameters
#### Path Parameters
- **n** (int) - Required - Number of links, clamped to [1, 200].

### Response
#### Success Response (302)
- **Location** (string) - Redirect to `/links/{n}/0`

#### Response Example
```
(redirect)
```
```

--------------------------------

### GET /cache/:n

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Sets a Cache-Control header for n seconds.

```APIDOC
## [GET] /cache/:n

### Description
Sets a Cache-Control header for n seconds.

### Method
GET

### Endpoint
/cache/:n

### Parameters
#### Path Parameters
- **n** (integer) - Required - The number of seconds for the Cache-Control header.
```

--------------------------------

### Usage example for json_safe

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/helpers.md

Shows how to call json_safe with text and binary payloads. Text input returns the decoded string; binary input returns a data: URL with the given content type.

```python
from httpbin.helpers import json_safe

text = json_safe("hello".encode("utf-8"))          # "hello"
blob = json_safe(b"\x00\x01\xff")                    # "data:application/octet-stream;base64,AAH/"
img  = json_safe(b"\x89PNG...", content_type="image/png")
```

--------------------------------

### GET /deflate

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a JSON response with deflate content encoding.

```APIDOC
## GET /deflate

### Description
Returns a JSON response with deflate content encoding.

### Method
GET

### Endpoint
`/deflate`

### Response
#### Success Response (200)
- **body** (JSON) - Object with `origin`, `headers`, `method`, `deflated: true`
- **Content-Encoding** (string) - `deflate`

#### Response Example
```json
{
  "origin": "...",
  "headers": {},
  "method": "GET",
  "deflated": true
}
```
```

--------------------------------

### GET /image

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Returns a page containing an image based on the sent Accept header.

```APIDOC
## GET /image

### Description
Returns a page containing an image based on the sent Accept header.

### Method
GET

### Endpoint
/image

```

--------------------------------

### GET/POST/PUT/DELETE/PATCH/TRACE /anything

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Returns request data for any method.

```APIDOC
## [GET/POST/PUT/DELETE/PATCH/TRACE] /anything

### Description
Returns request data for any method. Accepts any path after /anything.

### Method
GET, POST, PUT, DELETE, PATCH, TRACE

### Endpoint
/anything, /anything/<path:anything>

### Parameters
#### Path Parameters
- **anything** (string) - Optional - Any path suffix.

### Response
#### Success Response (200)
- **args** (object) - Query parameters.
- **data** (string) - Request body.
- **files** (object) - Uploaded files.
- **form** (object) - Form data.
- **headers** (object) - Request headers.
- **json** (object) - JSON body.
- **method** (string) - HTTP method.
- **origin** (string) - Requester's IP.
- **url** (string) - Full request URL.

#### Response Example
```json
{
  "args": {},
  "data": "",
  "files": {},
  "form": {},
  "headers": {},
  "json": null,
  "method": "GET",
  "origin": "127.0.0.1",
  "url": "http://httpbin.org/anything"
}
```
```

--------------------------------

### GET /delay/:n

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Delays responding for min(n, 10) seconds.

```APIDOC
## [GET] /delay/:n

### Description
Delays responding for min(n, 10) seconds.

### Method
GET

### Endpoint
/delay/:n

### Parameters
#### Path Parameters
- **n** (integer) - Required - The number of seconds to delay.
```

--------------------------------

### GET /digest-auth/{qop}/{user}/{passwd}?require-cookie=true

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/errors.md

Returns 403 if the request has a Cookie header but the fake cookie is not set correctly.

```APIDOC
## [GET] /digest-auth/{qop}/{user}/{passwd}?require-cookie=true

### Description
Returns 403 if the request has a Cookie header but the fake cookie is not set correctly.

### Method
GET

### Endpoint
/digest-auth/{qop}/{user}/{passwd}?require-cookie=true

### Parameters
#### Path Parameters
- **qop** (string) - Required - Quality of protection.
- **user** (string) - Required - Username.
- **passwd** (string) - Required - Password.

#### Query Parameters
- **require-cookie** (boolean) - Required - Must be true.

### Response
#### Error Response (403)
- **body** (JSON) - `{"errors": ["missing cookie set on challenge"]}`
```

--------------------------------

### Usage example for CaseInsensitiveDict

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/structures.md

Shows how to use CaseInsensitiveDict for case-insensitive header access and for parsing query args. Demonstrates that missing keys return None instead of raising KeyError, and that duplicate keys keep the last value.

```python
from httpbin.structures import CaseInsensitiveDict

h = CaseInsensitiveDict({"Content-Type": "application/json"})
h["content-type"]     # "application/json"
"CONTENT-TYPE" in h   # True
h["missing"]          # None  (no KeyError, unlike dict)

# also usable as a regular dict for args parsing
args = CaseInsensitiveDict([("Code", "200"), ("Code", "201")])
args["code"]          # "201" — last value wins, matching request.args.items() semantics
```

--------------------------------

### GET|POST /response-headers

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Echoes query (GET) or form (POST) parameters as response headers and returns the header set as JSON.

```APIDOC
## [GET|POST] /response-headers

### Description
Echoes query (GET) or form (POST) parameters as response headers and returns the header set as JSON.

### Method
GET, POST

### Endpoint
/response-headers

### Parameters
#### Query Parameters (GET)
- **<header-name>** (string) - Optional - Header name and value to echo.

#### Request Body (POST)
- **<header-name>** (string) - Optional - Form field name and value to echo as header.

### Response
#### Success Response (200)
- **body** (object) - JSON object containing the rendered header set.

### Notes
- Each iteration re-serializes the current header set into the JSON body, so header-like keys appear both in headers and JSON body.
```

--------------------------------

### Usage example for weighted_choice

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/utils.md

Shows how to use weighted_choice with status codes. Creates choices list with weights, calls weighted_choice, then passes result to status_code. The comment notes that 404 is chosen about 50% of the time for the given weights.

```python
from httpbin.utils import weighted_choice
from httpbin.core import status_code

# /status/<codes> picks weighted responses, e.g. "200:1,404:3,500:2"
choices = [(200, 1), (404, 3), (500, 2)]
code = weighted_choice(choices)     # 404 about 50% of the time
response = status_code(code)
print(response.status_code)         # one of 200 / 404 / 500
```

--------------------------------

### GET /etag/{etag}

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/errors.md

Returns the ETag. Returns 412 if If-Match header does not match the etag.

```APIDOC
## [GET] /etag/{etag}

### Description
Returns the ETag. Returns 412 if If-Match header does not match the etag.

### Method
GET

### Endpoint
/etag/{etag}

### Parameters
#### Path Parameters
- **etag** (string) - Required - The ETag value.

#### Headers
- **If-Match** (string) - Optional - Must contain the etag or '*'.

### Response
#### Error Response (412)
- **body** - empty
```

--------------------------------

### GET/POST/PUT/DELETE/PATCH/TRACE /redirect-to

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Redirects to a given URL.

```APIDOC
## [GET/POST/PUT/DELETE/PATCH/TRACE] /redirect-to

### Description
Redirects to a given URL.

### Method
GET, POST, PUT, DELETE, PATCH, TRACE

### Endpoint
/redirect-to

### Parameters
#### Query Parameters
- **url** (string) - Required - The URL to redirect to.
- **status_code** (integer) - Optional - The status code to use for the redirect.

### Response
#### Success Response (302)
- **Location** (string) - The redirect URL.

#### Response Example
```
HTTP/1.1 302 Found
Location: http://example.com/
```
```

--------------------------------

### GET /get

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns the request data including URL, query parameters, headers, and origin. This endpoint is useful for inspecting what the server receives.

```APIDOC
## [GET] /get

### Description
Returns the request data including URL, query parameters, headers, and origin. This endpoint is useful for inspecting what the server receives.

### Method
GET

### Endpoint
/get

### Parameters
#### Query Parameters
- None

### Request Example
No request body required.

### Response
#### Success Response (200)
- **url** (string) - The full URL of the request.
- **args** (object) - Query parameters as key-value pairs.
- **headers** (object) - Request headers.
- **origin** (string) - The client IP address or forwarded IP.

#### Response Example
{
  "url": "http://example.com/get",
  "args": {},
  "headers": {},
  "origin": "127.0.0.1"
}
```

--------------------------------

### GET /image

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/errors.md

Returns an image. Returns 406 if the Accept header does not match a supported media type.

```APIDOC
## [GET] /image

### Description
Returns an image. Returns 406 if the Accept header does not match a supported media type.

### Method
GET

### Endpoint
/image

### Parameters
#### Headers
- **Accept** (string) - Optional - Must match one of: image/webp, image/svg+xml, image/jpeg, image/png, image/*.

### Response
#### Error Response (406)
- **body** (JSON) - `{"message": "Client did not request a supported media type.", "accept": [...]}`
- **headers** - `Content-Type: application/json`
```

--------------------------------

### GET /digest-auth/<qop>/<user>/<passwd>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Performs digest authentication with MD5 algorithm. Returns authentication status and user on success, or a 401 challenge on failure.

```APIDOC
## [GET] /digest-auth/<qop>/<user>/<passwd>

### Description
Performs digest authentication with MD5 algorithm. Returns authentication status and user on success, or a 401 challenge on failure.

### Method
GET

### Endpoint
/digest-auth/<qop>/<user>/<passwd>

### Parameters
#### Path Parameters
- **qop** (string) - Required - Quality of protection, must be `auth` or `auth-int`
- **user** (string) - Required - Username for authentication
- **passwd** (string) - Required - Password for authentication

### Response
#### Success Response (200)
- **authenticated** (boolean) - Always true
- **user** (string) - The authenticated username

#### Response Example
{
  "authenticated": true,
  "user": "user"
}

#### Error Response (401)
- Digest challenge with `WWW-Authenticate` header, realm `me@kennethreitz.com`
```

--------------------------------

### GET /cookies

Source: https://github.com/postmanlabs/httpbin/blob/master/httpbin/templates/httpbin.1.html

Returns cookie data.

```APIDOC
## [GET] /cookies

### Description
Returns cookie data.

### Method
GET

### Endpoint
/cookies
```

--------------------------------

### GET|POST|PUT|DELETE|PATCH|TRACE /anything, /anything/<path:anything>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Accepts all six HTTP verbs on both the bare path and any path suffix. Returns request details including URL, arguments, headers, origin, method, form data, data, files, and JSON.

```APIDOC
## [GET|POST|PUT|DELETE|PATCH|TRACE] /anything, /anything/<path:anything>

### Description
Accepts all six HTTP verbs on both the bare path and any path suffix. Returns request details including URL, arguments, headers, origin, method, form data, data, files, and JSON.

### Method
GET, POST, PUT, DELETE, PATCH, TRACE

### Endpoint
/anything, /anything/<path:anything>

### Response
#### Success Response (200)
- **url** (string) - The request URL
- **args** (object) - Query parameters
- **headers** (object) - Request headers
- **origin** (string) - Client IP address
- **method** (string) - HTTP method used
- **form** (object) - Form data
- **data** (string) - Request body data
- **files** (object) - Uploaded files
- **json** (object) - JSON body

#### Response Example
{
  "url": "https://httpbin.org/anything",
  "args": {},
  "headers": {},
  "origin": "127.0.0.1",
  "method": "GET",
  "form": {},
  "data": "",
  "files": {},
  "json": null
}
```

--------------------------------

### GET /basic-auth/<user>/<passwd>

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Requires a valid HTTP Basic Authorization header matching the path credentials. Returns authentication status and user on success, or a 401 challenge on failure.

```APIDOC
## [GET] /basic-auth/<user>/<passwd>

### Description
Requires a valid HTTP Basic Authorization header matching the path credentials. Returns authentication status and user on success, or a 401 challenge on failure.

### Method
GET

### Endpoint
/basic-auth/<user>/<passwd>

### Parameters
#### Path Parameters
- **user** (string) - Required - Username for authentication
- **passwd** (string) - Required - Password for authentication

### Response
#### Success Response (200)
- **authenticated** (boolean) - Always true
- **user** (string) - The authenticated username

#### Response Example
{
  "authenticated": true,
  "user": "user"
}

#### Error Response (401)
- Empty body, header `WWW-Authenticate: Basic realm="Fake Realm"`
```

--------------------------------

### GET /image/svg

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns an SVG image.

```APIDOC
## GET /image/svg

### Description
Returns an SVG image.

### Method
GET

### Endpoint
/image/svg

### Response
#### Success Response (200)
Returns an SVG image with Content-Type: image/svg+xml.
```

--------------------------------

### Flask app instance configuration

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/api-reference/core.md

Creates the Flask application with a custom template folder, enables debug mode based on the DEBUG environment variable, sets JSONIFY_PRETTYPRINT_REGULAR to True, adds a template global for tracking, and configures Swagger. Also applies BaseResponse.autocorrect_location_header = False to prevent Werkzeug from rewriting Location header casing.

```python
app = Flask(__name__, template_folder=tmpl_dir)
app.debug = bool(os.environ.get("DEBUG"))
app.config["JSONIFY_PRETTYPRINT_REGULAR"] = True

app.add_template_global("HTTPBIN_TRACKING" in os.environ, name="tracking_enabled")

app.config["SWAGGER"] = {"title": "httpbin.org", "uiversion": 3}
```

```python
from httpbin import app  # re-exported by httpbin/__init__.py

if __name__ == "__main__":
    app.run(port=8080)  # dev server; production uses gunicorn
```

--------------------------------

### GET /redirect/{n}

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Redirects the client to a chain of redirects, decrementing the count each time. When n equals 1, it redirects to /get, using an absolute URL if the query parameter absolute=true is provided.

```APIDOC
## [GET] /redirect/{n}

### Description
Redirects the client to a chain of redirects, decrementing the count each time. When n equals 1, it redirects to /get, using an absolute URL if the query parameter absolute=true is provided.

### Method
GET

### Endpoint
/redirect/{n}

### Parameters
#### Path Parameters
- **n** (integer) - Required - The number of redirects to perform.

#### Query Parameters
- **absolute** (string) - Optional - If set to "true", the final redirect Location will be an absolute URL.

### Response
#### Success Response (302)
- **Location** (string) - The redirect target URL.

#### Response Example
HTTP/1.1 302 Found
Location: /get

```

--------------------------------

### GET /image/jpeg

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/endpoints.md

Returns a JPEG image.

```APIDOC
## GET /image/jpeg

### Description
Returns a JPEG image.

### Method
GET

### Endpoint
/image/jpeg

### Response
#### Success Response (200)
Returns a JPEG image with Content-Type: image/jpeg.
```

--------------------------------

### Run httpbin dev server with CLI arguments

Source: https://github.com/postmanlabs/httpbin/blob/master/_autodocs/configuration.md

Starts the Flask development server when the module is run directly. Supports --port (default 5000) and --host (default 127.0.0.1) arguments. Invoke with `python -m httpbin.core --host 0.0.0.0 --port 8080`.

```python
if __name__ == "__main__":
    parser = argparse.ArgumentParser()
    parser.add_argument("--port", type=int, default=5000)
    parser.add_argument("--host", default="127.0.0.1")
    args = parser.parse_args()
    app.run(port=args.port, host=args.host)
```
Tokens:
Raw