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-04-19T20:23:43Z",
	"description": "acme http response",
	"headers": {
		"content-type": "text/plain"
	},
	"id": "bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N",
	"metadata": "{\"environment\": \"staging\"}",
	"status_code": 418,
	"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N"
}

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_2fKmcc1iaS4PnYQV1ff6iCLKI3N

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_2fKmcc1iaS4PnYQV1ff6iCLKI3N

Response

Returns a 200 response on success

Example Response

{
	"body": "I'm a teapot",
	"created_at": "2024-04-19T20:23:43Z",
	"description": "acme http response",
	"headers": {
		"content-type": "text/plain"
	},
	"id": "bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N",
	"metadata": "{\"environment\": \"staging\"}",
	"status_code": 418,
	"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N"
}

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-04-19T20:23:43Z",
			"headers": null,
			"id": "bkdhr_2fKmcZgRe5lU5KuvWGqW6c2j976",
			"status_code": 200,
			"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2fKmcZgRe5lU5KuvWGqW6c2j976"
		},
		{
			"body": "I'm a teapot",
			"created_at": "2024-04-19T20:23:43Z",
			"description": "acme http response",
			"headers": {
				"content-type": "text/plain"
			},
			"id": "bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N",
			"metadata": "{\"environment\": \"staging\"}",
			"status_code": 418,
			"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N"
		},
		{
			"body": "one",
			"created_at": "2024-04-19T20:23:36Z",
			"headers": null,
			"id": "bkdhr_2fKmbgvczNt6xkgCZ4zIfjoOfuV",
			"status_code": 200,
			"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2fKmbgvczNt6xkgCZ4zIfjoOfuV"
		}
	],
	"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_2fKmcc1iaS4PnYQV1ff6iCLKI3N

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-04-19T20:23:43Z",
	"description": "acme http response",
	"headers": {
		"content-type": "text/plain"
	},
	"id": "bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N",
	"metadata": "{\"environment\": \"production\"}",
	"status_code": 418,
	"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2fKmcc1iaS4PnYQV1ff6iCLKI3N"
}

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