Extensions API
Direct Responses
API reference for Direct Responses (extensions.apoxy.dev/v1alpha2)
API Group: extensions.apoxy.dev/v1alpha2
Operations
List Direct Responses
GET/apis/extensions.apoxy.dev/v1alpha2/directresponses
List DirectResponse
Response
200: OK
Create Direct Response
POST/apis/extensions.apoxy.dev/v1alpha2/directresponses
Create a DirectResponse
Request Body
Spec fields (DirectResponseSpec):
| Field | Type | Description |
|---|---|---|
body | CustomResponseBody | Body is the response body configuration. |
contentType | string | ContentType is the Content-Type header value. Defaults to "text/plain" if not specified. |
headers | Header[] | Headers are additional HTTP headers to include in the response. |
statusCode | integer (int32) | StatusCode is the HTTP status code to return. Defaults to 200 if not specified. |
Response
200: OK201: Created202: Accepted
Delete All Direct Responses
DELETE/apis/extensions.apoxy.dev/v1alpha2/directresponses
Delete collection of DirectResponse
Response
200: OK
Get Direct Response
GET/apis/extensions.apoxy.dev/v1alpha2/directresponses/{name}
Get the specified DirectResponse
Response
200: OK
Replace Direct Response
PUT/apis/extensions.apoxy.dev/v1alpha2/directresponses/{name}
Replace the specified DirectResponse
Request Body
Spec fields (DirectResponseSpec):
| Field | Type | Description |
|---|---|---|
body | CustomResponseBody | Body is the response body configuration. |
contentType | string | ContentType is the Content-Type header value. Defaults to "text/plain" if not specified. |
headers | Header[] | Headers are additional HTTP headers to include in the response. |
statusCode | integer (int32) | StatusCode is the HTTP status code to return. Defaults to 200 if not specified. |
Response
200: OK201: Created
Update Direct Response
PATCH/apis/extensions.apoxy.dev/v1alpha2/directresponses/{name}
Partially update the specified DirectResponse
Response
200: OK201: Created
Delete Direct Response
DELETE/apis/extensions.apoxy.dev/v1alpha2/directresponses/{name}
Delete a DirectResponse
Response
200: OK202: Accepted
Schema Reference
CustomResponseBody
| Field | Type | Description |
|---|---|---|
inline | string | Inline is the literal body content when Type is "Inline". |
type | string | Type specifies how the body is provided. Currently only "Inline" is supported. (required) |