Interface Origins

A list of origin configurations. Each origin configuration defines how Edgio may communicate with your web server(s).

Hierarchy

  • Origins

Properties

balancer? hosts? name? override_host_header? pci_certified_shields? retry? shields? tls_verify? type?

Properties

Optional balancer

balancer?: "primary_failover" | "round_robin" | "carp" | "carp64" | "static_with_tags" | "static_weighted" | "static_nocache_bypass" | "sqf"

The method through which Edgio load balances traffic proxied from our network to an origin configuration's hosts. Valid values are: primary_failover and round_robin.

Optional hosts

hosts?: OriginBackends[]

A list of host(s). Each host determines how Edgio will communicate with your web server(s).

Optional name

name?: string

The origin configuration's name.

Optional override_host_header

override_host_header?: string

Overrides the client's Host header for requests proxied to this origin.

Optional pci_certified_shields

pci_certified_shields?: boolean

Determines whether Origin Shield will be restricted to Payment Card Industry (PCI)-certified locations.

Optional retry

retry?: {
    after_seconds?: number;
    ignore_retry_after_header?: boolean;
    max_requests: number;
    max_wait_seconds: number;
    status_codes: HttpStatusCode[];
}

Retrying certain status codes

Type declaration

  • Optional after_seconds?: number

    The number of seconds that our edge servers will wait before retry.

  • Optional ignore_retry_after_header?: boolean

    Ignore the Retry-After origin response header.

  • max_requests: number

    Maximum number of request retries.

  • max_wait_seconds: number

    The maximum number of seconds that our edge servers will wait before retry.

  • status_codes: HttpStatusCode[]

    Defines the retryable status codes.

Optional shields

shields?: {
    apac?: string;
    emea?: string;
    global?: string;
    us_east?: string;
    us_west?: string;
}

The origin's Origin Shield configuration.

Type declaration

  • Optional apac?: string

    The code for the Origin Shield POP that will be assigned to the Asia-Pacific (APAC) region. Omit this property or set it to blank to proxy requests to a configured region that provides the lowest round-trip time (RTT). Set to bypass to forward all requests from this region to the origin.

  • Optional emea?: string

    The code for the Origin Shield POP that will be assigned to the Europe, Middle East, and Africa (EMEA) region. Omit this property or set it to blank to proxy requests to a configured region that provides the lowest round-trip time (RTT). Set to bypass to forward all requests from this region to the origin.

  • Optional global?: string

    Reserved for future use.

  • Optional us_east?: string

    The code for the Origin Shield POP that will be assigned to the Eastern United States region. Omit this property or set it to blank to proxy requests to a configured region that provides the lowest round-trip time (RTT). Set to bypass to forward all requests from this region to the origin.

  • Optional us_west?: string

    The code for the Origin Shield POP that will be assigned to the Western United States region. Omit this property or set it to blank to proxy requests to a configured region that provides the lowest round-trip time (RTT). Set to bypass to forward all requests from this region to the origin.

Optional tls_verify

tls_verify?: {
    allow_self_signed_certs?: boolean;
    pinned_certs?: [] | [string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string];
    sni_hint_and_strict_san_check?: string;
    use_sni?: boolean;
}

TLS settings.

Type declaration

  • Optional allow_self_signed_certs?: boolean

    Determines whether to allow Edgio to serve traffic when it detects a self-signed certificate.

  • Optional pinned_certs?: [] | [string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string]

    The SHA-1 digest for the public key of your end-entity (i.e., leaf) certificate.

    Max Items

    5

  • Optional sni_hint_and_strict_san_check?: string
  • Optional use_sni?: boolean

    Determines whether Edgio will send a Server Name Indication (SNI) hint to your origin server during the TLS handshake.

Optional type

type?: "customer_origin" | "cdn_storage"

The only valid value is customer_origin.

Settings

Member Visibility

Theme

Generated using TypeDoc