Fastly will upload log messages periodically to the server in the format specified in the FTP object.

Data model

addressstringAn hostname or IPv4 address.
hostnamestringHostname used.
ipv4stringIPv4 address of the host.
passwordstringThe password for the server. For anonymous use an email address.
pathstringThe path to upload log files to. If the path ends in / then it is treated as a directory.
public_keystringA PGP public key that Fastly will use to encrypt your log files before writing them to disk.
userstringThe username for the server. Can be anonymous.
compression_codecstringThe codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error.
formatstringA Fastly log format string. [Default %h %l %u %t "%r" %>s %b]
format_versionintegerThe version of the custom logging format used for the configured endpoint. 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. [Default 2]
gzip_levelintegerThe level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. [Default 0]
message_typestringHow the message should be formatted. [Default classic]
namestringThe name for the real-time logging configuration.
periodintegerHow frequently log files are finalized so they can be available for reading (in seconds). [Default 3600]
placementstringWhere in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver.
portintegerThe port number. [Default 21]
response_conditionstringThe name of an existing condition in the configured endpoint, or leave blank to always execute.
timestamp_formatstringA timestamp format. Read-only.
created_atstringDate and time in ISO 8601 format. Read-only.
deleted_atstringDate and time in ISO 8601 format. Read-only.
service_idstringAlphanumeric string identifying the service. Read-only.
updated_atstringDate and time in ISO 8601 format. Read-only.
versionstringString identifying a service version. Read-only.


List FTP log endpoints


Create an FTP log endpoint


Get an FTP log endpoint


Update an FTP log endpoint


Delete an FTP log endpoint