HTTP Response Backends
Create HTTP Response Backend
Request
POST /backends/http_response
Example Request
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"body":"I'm a teapot","description":"acme http response","headers":{"Content-Type":"text/plain"},"metadata":"{\"environment\": \"staging\"}","status_code":418}' \
https://api.ngrok.com/backends/http_response
Parameters
Name | Type | Description |
---|---|---|
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
body | string | body to return as fixed content |
headers | Map<string, string> | headers to return |
status_code | int32 | status code to return |
Response
Returns a 201 response on success
Example Response
{
"body": "I'm a teapot",
"created_at": "2024-05-23T20:36:22Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l",
"metadata": "{\"environment\": \"staging\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l"
}
Fields
Name | Type | Description |
---|---|---|
id | string | |
uri | string | URI of the HTTPResponseBackend API resource |
created_at | string | timestamp when the backend was created, RFC 3339 format |
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
body | string | body to return as fixed content |
headers | Map<string, string> | headers to return |
status_code | int32 | status code to return |
Delete HTTP Response Backend
Request
DELETE /backends/http_response/{id}
Example Request
curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/backends/http_response/bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l
Response
Returns a 204 response with no body on success
Get HTTP Response Backend
Request
GET /backends/http_response/{id}
Example Request
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/backends/http_response/bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l
Response
Returns a 200 response on success
Example Response
{
"body": "I'm a teapot",
"created_at": "2024-05-23T20:36:22Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l",
"metadata": "{\"environment\": \"staging\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l"
}
Fields
Name | Type | Description |
---|---|---|
id | string | |
uri | string | URI of the HTTPResponseBackend API resource |
created_at | string | timestamp when the backend was created, RFC 3339 format |
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
body | string | body to return as fixed content |
headers | Map<string, string> | headers to return |
status_code | int32 | status code to return |
List HTTP Response Backends
Request
GET /backends/http_response
Example Request
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/backends/http_response
Response
Returns a 200 response on success
Example Response
{
"backends": [
{
"body": "one",
"created_at": "2024-05-23T20:36:22Z",
"headers": null,
"id": "bkdhr_2gsqMDg3slHTLjx922rbhXGJETR",
"status_code": 200,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2gsqMDg3slHTLjx922rbhXGJETR"
},
{
"body": "I'm a teapot",
"created_at": "2024-05-23T20:36:22Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l",
"metadata": "{\"environment\": \"staging\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l"
},
{
"body": "one",
"created_at": "2024-05-23T20:36:16Z",
"headers": null,
"id": "bkdhr_2gsqLSghpTLNbLmkKiKojJ9k4bq",
"status_code": 200,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2gsqLSghpTLNbLmkKiKojJ9k4bq"
}
],
"next_page_uri": null,
"uri": "https://api.ngrok.com/backends/http_response"
}
Fields
Name | Type | Description |
---|---|---|
backends | HTTPResponseBackend | |
uri | string | |
next_page_uri | string |
HTTPResponseBackend fields
Name | Type | Description |
---|---|---|
id | string | |
uri | string | URI of the HTTPResponseBackend API resource |
created_at | string | timestamp when the backend was created, RFC 3339 format |
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
body | string | body to return as fixed content |
headers | Map<string, string> | headers to return |
status_code | int32 | status code to return |
Update HTTP Response Backend
Request
PATCH /backends/http_response/{id}
Example Request
curl \
-X PATCH \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"metadata":"{\"environment\": \"production\"}"}' \
https://api.ngrok.com/backends/http_response/bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l
Parameters
Name | Type | Description |
---|---|---|
id | string | |
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
body | string | body to return as fixed content |
headers | Map<string, string> | headers to return |
status_code | int32 | status code to return |
Response
Returns a 200 response on success
Example Response
{
"body": "I'm a teapot",
"created_at": "2024-05-23T20:36:22Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l",
"metadata": "{\"environment\": \"production\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2gsqMAwmmnBVueoiMLyPaeskc3l"
}
Fields
Name | Type | Description |
---|---|---|
id | string | |
uri | string | URI of the HTTPResponseBackend API resource |
created_at | string | timestamp when the backend was created, RFC 3339 format |
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
body | string | body to return as fixed content |
headers | Map<string, string> | headers to return |
status_code | int32 | status code to return |