Interface Headers

Add, modify, or delete headers from the request or response.

Hierarchy

  • Headers

Indexable

[k: string]: unknown

Properties

add_response_headers? age_response_header? debug_header? remove_origin_response_headers? remove_response_headers? server_timing_header? set_client_ip_custom_header? set_origin_response_headers? set_request_headers? set_response_headers?

Properties

Optional add_response_headers

add_response_headers?: HttpResponseHeader | {
    execute_on_shield: boolean;
    headers: HttpResponseHeader;
}

Optional age_response_header

age_response_header?: boolean

if enabled our CDN service will generate an Age header and include it within the response.

Optional debug_header

debug_header?: boolean

Determines whether a response may include debug cache response headers. These response headers provide information on the cache policy for the requested asset.

Optional remove_origin_response_headers

remove_origin_response_headers?: string[]

Deletes one or more custom header(s) from the response provided by an origin server.

Optional remove_response_headers

remove_response_headers?: string[] | {
    execute_on_shield: boolean;
    headers: string[];
}

Optional server_timing_header

server_timing_header?: boolean

Reserved for future use.

Optional set_client_ip_custom_header

set_client_ip_custom_header?: string

Adds a custom request header that identifies the requesting client by IP address.

Optional set_origin_response_headers

set_origin_response_headers?: HttpResponseHeader

Optional set_request_headers

set_request_headers?: HttpRequestHeader | {
    execute_on_shield: boolean;
    headers: HttpRequestHeader;
}

Optional set_response_headers

set_response_headers?: HttpResponseHeader | {
    execute_on_shield: boolean;
    headers: HttpResponseHeader;
}

Settings

Member Visibility

Theme

Generated using TypeDoc