SFTP

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

Data model

addressStringThe hostname or IPv4 address.
created_atStringTime-stamp (GMT) when the endpoint was created.
deleted_atStringTime-stamp (GMT) when the endpoint was deleted.
formatStringApache style log formatting.
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.
gzip_levelIntegerWhat level of gzip encoding to have when dumping logs (default 0, no compression).
message_typeStringHow the message should be formatted. One of:.
classic(default) RFC 3164 syslog prefix.
logglyRFC 5424 structured syslog.
logplexHeroku-style length prefixed syslog.
blankNo prefix. Useful for writing JSON and CSV.
nameStringThe name of the SFTP endpoint.
passwordStringThe password for the server. If both password and secret_key are passed, secret_key will be used in preference.
pathStringThe path to upload logs to. The directory must exist on the SFTP server before logs can be saved to it.
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, overriding any format_version default. Can be none or waf_debug. This field is not required and has no default value.
portIntegerThe port number (default 22).
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.
secret_keyStringThe SSH private key for the server. If both password and secret_key are passed, secret_key will be used in preference.
service_idStringThe alphanumeric string identifying a service.
ssh_known_hostsStringA list of host keys for all hosts we can connect to over SFTP.
timestamp_formatStringstrftime specified timestamp formatting (default "%Y-%m-%dT%H:%M:%S.000").
updated_atStringTime-stamp (GMT) when the endpoint was updated.
userStringThe username for the server.
versionIntegerThe current version of a service.

Endpoints

List SFTP log endpoints

GET/service/service_id/version/version/logging/sftp

Get an SFTP log endpoint

GET/service/service_id/version/version/logging/sftp/name

Create an SFTP log endpoint

POST/service/service_id/version/version/logging/sftp

Update an SFTP log endpoint

PUT/service/service_id/version/version/logging/sftp/old_name

Delete an SFTP log endpoint

DELETE/service/service_id/version/version/logging/sftp/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.