HTTP Response Backends#

Do not construct this object directly, instead access the http_response_backends property of an ngrok.Client object.

class ngrok.services.HTTPResponseBackendsClient(client)[source]#
create(description='', metadata='', body='', headers={}, status_code=None)[source]#
Parameters:

  • description (str) – human-readable description of this backend. Optional

  • metadata (str) – arbitrary user-defined machine-readable data of this backend. Optional

  • body (str) – body to return as fixed content

  • headers (Mapping[str, str]) – headers to return

  • status_code (Optional[int, None]) – status code to return

https://ngrok.com/docs/api#api-http-response-backends-create

Return type:

HTTPResponseBackend

delete(id)[source]#
Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-http-response-backends-delete

get(id)[source]#
Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-http-response-backends-get

Return type:

HTTPResponseBackend

list(before_id=None, limit=None)[source]#
Parameters:

  • before_id (Optional[str, None]) –

  • limit (Optional[str, None]) –

https://ngrok.com/docs/api#api-http-response-backends-list

Return type:

HTTPResponseBackendList

update(id, description=None, metadata=None, body=None, headers=None, status_code=None)[source]#
Parameters:

  • id (str) –

  • description (Optional[str, None]) – human-readable description of this backend. Optional

  • metadata (Optional[str, None]) – arbitrary user-defined machine-readable data of this backend. Optional

  • body (Optional[str, None]) – body to return as fixed content

  • headers (Optional[Mapping[str, str], None]) – headers to return

  • status_code (Optional[int, None]) – status code to return

https://ngrok.com/docs/api#api-http-response-backends-update

Return type:

HTTPResponseBackend