HTTP Response Backends
Create HTTP Response Backend
Request
POST /backends/http_response
Example Request
Loading…
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
Loading…
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
Loading…
Response
Returns a 204 response with no body on success
Get HTTP Response Backend
Request
GET /backends/http_response/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
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
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
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
Loading…
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
Loading…
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 |