HTTPS

WARNING: This information is part of a limited availability release. Portions of this API may be subject to changes and improvements over time. Fields marked deprecated may be removed in the future and their use is discouraged. For more information, see our product and feature lifecycle descriptions.

Fastly will upload log messages to an HTTPS endpoint in the format specified in the HTTPS object. The HTTPS endpoint requires proof of domain ownership before logs can be received. Learn how to validate your domain in our HTTPS endpoint documentation.

Data model

nameStringThe name for the HTTPS configuration. Required.
service_idStringThe alphanumeric string identifying a service.
versionIntegerThe current version of a service.
response_conditionStringThe name of an existing condition in the configured endpoint. Leave blank to always execute.
formatStringApache style log formatting.
urlStringURL that log data will be sent to. Must use the https protocol. Required.
request_max_entriesIntegerThe maximum number of logs sent in one request. Defaults to no limit.
request_max_bytesIntegerThe maximum number of bytes sent in one request. Defaults to no limit.
content_typeStringContent type of the header sent with the request.
header_nameStringName of the custom header sent with the request.
header_valueStringValue of the custom header sent with the request.
methodStringHTTP method used for request. Can be POST or PUT. Defaults to POST if not specified.
json_formatStringEnforces valid JSON formatting for log entries. Can be disabled 0, array of json (wraps JSON log batches in an array) 1, or newline delimited json (places each JSON log entry onto a new line in a batch) 2.
placementStringWhere in the generated VCL the logging call should be placed, overriding any format_version default. Can be none or waf_debug. This field is not required and has no default value.
tls_ca_certStringA secure certificate to authenticate the server with. Must be in PEM format.
tls_client_certStringThe client certificate used to make authenticated requests. Must be in PEM format.
tls_client_keyStringThe client private key used to make authenticated requests. Must be in PEM format.
tls_hostnameStringThe hostname used to verify the server's certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN).
message_typeStringHow the message should be formatted. One of:.
classicRFC 3164 syslog prefix.
logglyRFC 5424 structured syslog.
logplexHeroku-style length prefixed syslog.
blank(default) No prefix. Useful for writing JSON and CSV.
format_versionIntegerThe version of the custom logging format used for the configured endpoint. Can be either 2 (the default, version 2 log format) or 1 (the version 1 log format). The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1.
created_atStringTime-stamp (GMT) when the endpoint was created.
updated_atStringTime-stamp (GMT) when the endpoint was updated.
deleted_atStringTime-stamp (GMT) when the endpoint was deleted.

Endpoints

List HTTPS log endpoints

GET/service/service_id/version/version/logging/https

Get an HTTPS log endpoint

GET/service/service_id/version/version/logging/https/name

Create an HTTPS log endpoint

POST/service/service_id/version/version/logging/https

Update an HTTPS log endpoint

PUT/service/service_id/version/version/logging/https/old_name

Delete an HTTPS log endpoint

DELETE/service/service_id/version/version/logging/https/name

User contributed notes

We welcome comments that add use cases, ideas, tips, and caveats. All comments will be moderated before publication. To post support questions, visit our support center and we'll find you the help you need.