Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

post/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}

Path parameters

restapi_idstring required

The string identifier of the associated RestApi.

resource_idstring required

Specifies a test invoke method request's resource ID.

http_methodstring required

Specifies a test invoke method request's HTTP method.

Request body

pathWithQueryStringstring

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

bodystring

The simulated request body of an incoming invocation request.

headersobject

A key-value map of headers to simulate an incoming invocation request.

multiValueHeadersobject

The headers as a map from string to list of values to simulate an incoming invocation request.

clientCertificateIdstring

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

stageVariablesobject

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Response

Success

statusinteger

The HTTP status code.

bodystring

The body of the HTTP response.

headersobject

The headers of the HTTP response.

multiValueHeadersobject

The headers of the HTTP response as a map from string to list of values.

logstring

The API Gateway execution log for the test invoke request.

latencyinteger

The execution latency of the test invoke request.