Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EndpointConfiguration

Hierarchy

  • EndpointConfiguration

Index

Properties

Optional circuitBreaker

circuitBreaker: EndpointCircuitBreaker

circuit breaker module configuration or null

Optional compression

compression: EndpointCompression

compression module configuration or null

createdAt

createdAt: string

timestamp when the endpoint configuration was created, RFC 3339 format

description

description: string

human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes

id

id: string

unique identifier of this endpoint configuration

Optional ipPolicy

ip policy module configuration or null

Optional logging

logging module configuration or null

metadata

metadata: string

arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.

Optional mutualTls

mutual TLS module configuration or null

Optional oauth

oauth module configuration or null

Optional oidc

oidc module configuration or null

Optional requestHeaders

requestHeaders: EndpointRequestHeaders

request headers module configuration or null

Optional responseHeaders

responseHeaders: EndpointResponseHeaders

response headers module configuration or null

Optional saml

saml module configuration or null

Optional tlsTermination

tlsTermination: EndpointTLSTermination

TLS termination module configuration or null

type

type: string

they type of traffic this endpoint configuration can be applied to. one of: http, https, tcp

uri

uri: string

URI of the endpoint configuration API resource

Optional webhookValidation

webhookValidation: EndpointWebhookValidation

webhook validation module configuration or null

Generated using TypeDoc