Skip to main content

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

NameTypeDescription
descriptionstringhuman-readable description of this backend. Optional
metadatastringarbitrary user-defined machine-readable data of this backend. Optional
bodystringbody to return as fixed content
headersMap<string, string>headers to return
status_codeint32status code to return

Response

Returns a 201 response on success

Example Response

{
"body": "I'm a teapot",
"created_at": "2024-06-14T06:03:59Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2hrGyndhWCmObVT417cZ2njAO4q",
"metadata": "{\"environment\": \"staging\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2hrGyndhWCmObVT417cZ2njAO4q"
}

Fields

NameTypeDescription
idstring
uristringURI of the HTTPResponseBackend API resource
created_atstringtimestamp when the backend was created, RFC 3339 format
descriptionstringhuman-readable description of this backend. Optional
metadatastringarbitrary user-defined machine-readable data of this backend. Optional
bodystringbody to return as fixed content
headersMap<string, string>headers to return
status_codeint32status 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_2hrGyndhWCmObVT417cZ2njAO4q

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_2hrGyndhWCmObVT417cZ2njAO4q

Response

Returns a 200 response on success

Example Response

{
"body": "I'm a teapot",
"created_at": "2024-06-14T06:03:59Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2hrGyndhWCmObVT417cZ2njAO4q",
"metadata": "{\"environment\": \"staging\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2hrGyndhWCmObVT417cZ2njAO4q"
}

Fields

NameTypeDescription
idstring
uristringURI of the HTTPResponseBackend API resource
created_atstringtimestamp when the backend was created, RFC 3339 format
descriptionstringhuman-readable description of this backend. Optional
metadatastringarbitrary user-defined machine-readable data of this backend. Optional
bodystringbody to return as fixed content
headersMap<string, string>headers to return
status_codeint32status 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-06-14T06:03:59Z",
"headers": null,
"id": "bkdhr_2hrGynsNV58qoe9YZ4AcTch8S3u",
"status_code": 200,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2hrGynsNV58qoe9YZ4AcTch8S3u"
},
{
"body": "I'm a teapot",
"created_at": "2024-06-14T06:03:59Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2hrGyndhWCmObVT417cZ2njAO4q",
"metadata": "{\"environment\": \"staging\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2hrGyndhWCmObVT417cZ2njAO4q"
},
{
"body": "one",
"created_at": "2024-06-14T06:03:53Z",
"headers": null,
"id": "bkdhr_2hrGy2yLoXBeB6HmeNdR4g49TNd",
"status_code": 200,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2hrGy2yLoXBeB6HmeNdR4g49TNd"
}
],
"next_page_uri": null,
"uri": "https://api.ngrok.com/backends/http_response"
}

Fields

NameTypeDescription
backendsHTTPResponseBackend
uristring
next_page_uristring

HTTPResponseBackend fields

NameTypeDescription
idstring
uristringURI of the HTTPResponseBackend API resource
created_atstringtimestamp when the backend was created, RFC 3339 format
descriptionstringhuman-readable description of this backend. Optional
metadatastringarbitrary user-defined machine-readable data of this backend. Optional
bodystringbody to return as fixed content
headersMap<string, string>headers to return
status_codeint32status 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_2hrGyndhWCmObVT417cZ2njAO4q

Parameters

NameTypeDescription
idstring
descriptionstringhuman-readable description of this backend. Optional
metadatastringarbitrary user-defined machine-readable data of this backend. Optional
bodystringbody to return as fixed content
headersMap<string, string>headers to return
status_codeint32status code to return

Response

Returns a 200 response on success

Example Response

{
"body": "I'm a teapot",
"created_at": "2024-06-14T06:03:59Z",
"description": "acme http response",
"headers": {
"content-type": "text/plain"
},
"id": "bkdhr_2hrGyndhWCmObVT417cZ2njAO4q",
"metadata": "{\"environment\": \"production\"}",
"status_code": 418,
"uri": "https://api.ngrok.com/backends/http_response/bkdhr_2hrGyndhWCmObVT417cZ2njAO4q"
}

Fields

NameTypeDescription
idstring
uristringURI of the HTTPResponseBackend API resource
created_atstringtimestamp when the backend was created, RFC 3339 format
descriptionstringhuman-readable description of this backend. Optional
metadatastringarbitrary user-defined machine-readable data of this backend. Optional
bodystringbody to return as fixed content
headersMap<string, string>headers to return
status_codeint32status code to return