FTP

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

Data model

addressstringAn hostname or IPv4 address.
compression_codecstringThe codec used for compression of your logs. Valid values are zstd, snappy, and gzip. If the specified codec is "gzip", gzip_level will default to 3. To specify a different level, leave compression_codec blank and explicitly set the level using gzip_level. Specifying both compression_codec and gzip_level in the same API request will result in an error.
formatstringA Fastly log format string.
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.
gzip_levelintegerWhat level of gzip encoding to have when sending logs (default 0, no compression). If an explicit non-zero value is set, then compression_codec will default to "gzip." Specifying both compression_codec and gzip_level in the same API request will result in an error.
hostnamestringHostname used.
ipv4stringIPv4 address of the host.
message_typestringHow the message should be formatted.
namestringThe name for the real-time logging configuration.
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.
periodintegerHow frequently log files are finalized so they can be available for reading (in seconds).
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.
public_keystringA PGP public key that Fastly will use to encrypt your log files before writing them to disk.
response_conditionstringThe name of an existing condition in the configured endpoint, or leave blank to always execute.
timestamp_formatstringDate and time in ISO 8601 format.
userstringThe username for the server. Can be anonymous.
created_atstringDate and time in ISO 8601 format.
deleted_atstringDate and time in ISO 8601 format.
service_idstringAlphanumeric string identifying the service.
updated_atstringDate and time in ISO 8601 format.
versionintegerInteger identifying a service version.

Endpoints

List FTP log endpoints

GET/service/service_id/version/version_id/logging/ftp

Create an FTP log endpoint

POST/service/service_id/version/version_id/logging/ftp

Get an FTP log endpoint

GET/service/service_id/version/version_id/logging/ftp/logging_ftp_name

Update an FTP log endpoint

PUT/service/service_id/version/version_id/logging/ftp/logging_ftp_name

Delete an FTP log endpoint

DELETE/service/service_id/version/version_id/logging/ftp/logging_ftp_name