Skip to main content
Version: 2.6.0

FlowControlServiceHTTP_CheckHTTP​

FlowControlServiceHTTP_CheckHTTP

Request Body required
  • control_point string

    For an SDK based insertion, a Control Point can represent a particular feature or execution block within a Service. In case of Service Mesh or Middleware insertion, a Control Point can identify ingress vs egress calls or distinct listeners or filter chains.

  • destination object

    The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.

  • address string

    The address for this socket.

  • port int64

    The port for this socket.

  • protocol string

    Possible values: [TCP, UDP]

    Default value: TCP

  • request object

    Represents a network request, such as an HTTP request.

  • body string

    The HTTP request body.

  • headers object

    The HTTP request headers.

  • property name* string
  • host string

    The HTTP request Host header value.

  • method string

    The HTTP request method, such as GET, POST.

  • path string

    The request target, as it appears in the first line of the HTTP request. This includes the URL path and query-string. No decoding is performed.

  • protocol string

    The network protocol used with the request, such as "HTTP/1.0", "HTTP/1.1", or "HTTP/2".

  • scheme string

    The HTTP URL scheme, such as http and https.

  • size int64

    The HTTP request size in bytes. If unknown, it must be -1.

  • source object

    The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.

  • address string

    The address for this socket.

  • port int64

    The port for this socket.

  • protocol string

    Possible values: [TCP, UDP]

    Default value: TCP

Responses

A successful response.

Schema
  • denied_response object

    Supplies http attributes for a denied response.

  • body string

    This field allows the authorization service to send a response body data to the downstream client.

  • headers object

    This field allows the authorization service to send HTTP response headers to the downstream client.

  • property name* string
  • status int32

    This field allows the authorization service to send an HTTP response status code to the downstream client. If not set, Envoy sends 403 Forbidden HTTP status code by default.

  • dynamic_metadata object

    Optional response metadata that will be emitted as dynamic metadata to be consumed by the next filter.

  • ok_response object

    Supplies http attributes for an ok response.

  • dynamic_metadata object
  • headers object

    HTTP entity headers in addition to the original request headers.

  • property name* string
  • status object

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

    You can find out more about this error model and how to work with it in the API Design Guide.

  • code int32

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

  • details object[]

    A list of messages that carry the error details. There is a common set of message types for APIs to use.

  • Array [
  • @type string

    A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

    In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

    • If no scheme is provided, https is assumed.
    • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
    • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

    Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

    Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • ]
  • message string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

POST /v1/flowcontrol/checkhttp

Request

Base URL
https://aperture-agent
Body required
{

  "control_point": "string",

  "destination": {

    "address": "string",

    "port": 0,

    "protocol": "TCP"

  },

  "request": {

    "body": "string",

    "headers": {},

    "host": "string",

    "method": "string",

    "path": "string",

    "protocol": "string",

    "scheme": "string",

    "size": "string"

  },

  "source": {

    "address": "string",

    "port": 0,

    "protocol": "TCP"

  }

}
curl / cURL
curl -L -X POST 'https://aperture-agent/v1/flowcontrol/checkhttp' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "control_point": "string",
  "destination": {
    "address": "string",
    "port": 0,
    "protocol": "TCP"
  },
  "request": {
    "body": "string",
    "headers": {},
    "host": "string",
    "method": "string",
    "path": "string",
    "protocol": "string",
    "scheme": "string",
    "size": "string"
  },
  "source": {
    "address": "string",
    "port": 0,
    "protocol": "TCP"
  }
}'