Getting startedGuidesReferenceChangelog
Apoxy:// Docs / Reference / DirectResponse

DirectResponse

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):

FieldTypeDescription
bodyCustomResponseBodyBody is the response body configuration.
contentTypestringContentType is the Content-Type header value. Defaults to "text/plain" if not specified.
headersHeader[]Headers are additional HTTP headers to include in the response.
statusCodeinteger (int32)StatusCode is the HTTP status code to return. Defaults to 200 if not specified.

Response

  • 200: OK
  • 201: Created
  • 202: 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):

FieldTypeDescription
bodyCustomResponseBodyBody is the response body configuration.
contentTypestringContentType is the Content-Type header value. Defaults to "text/plain" if not specified.
headersHeader[]Headers are additional HTTP headers to include in the response.
statusCodeinteger (int32)StatusCode is the HTTP status code to return. Defaults to 200 if not specified.

Response

  • 200: OK
  • 201: Created

Update Direct Response

PATCH/apis/extensions.apoxy.dev/v1alpha2/directresponses/{name}

Partially update the specified DirectResponse

Response

  • 200: OK
  • 201: Created

Delete Direct Response

DELETE/apis/extensions.apoxy.dev/v1alpha2/directresponses/{name}

Delete a DirectResponse

Response

  • 200: OK
  • 202: Accepted

Schema Reference

CustomResponseBody

FieldTypeDescription
inlinestringInline is the literal body content when Type is "Inline".
typestringType specifies how the body is provided. Currently only "Inline" is supported. (required)