Skip to content

Latest commit

 

History

History
233 lines (159 loc) · 10.3 KB

LoggingFtpApi.md

File metadata and controls

233 lines (159 loc) · 10.3 KB
Raw

LoggingFtpApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
create_log_ftp POST /service/{service_id}/version/{version_id}/logging/ftp Create an FTP log endpoint
delete_log_ftp DELETE /service/{service_id}/version/{version_id}/logging/ftp/{logging_ftp_name} Delete an FTP log endpoint
get_log_ftp GET /service/{service_id}/version/{version_id}/logging/ftp/{logging_ftp_name} Get an FTP log endpoint
list_log_ftp GET /service/{service_id}/version/{version_id}/logging/ftp List FTP log endpoints
update_log_ftp PUT /service/{service_id}/version/{version_id}/logging/ftp/{logging_ftp_name} Update an FTP log endpoint

create_log_ftp

Create a FTP for a particular service and version.

let cfg = &Configuration::default();
let params = CreateLogFtpParams {
    // parameters
};
create_log_ftp(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
name Option<String> The name for the real-time logging configuration.
placement Option<String> Where 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.
response_condition Option<String> The name of an existing condition in the configured endpoint, or leave blank to always execute.
format Option<String> A Fastly log format string. [default to %h %l %u %t "%r" %>s %b]
format_version Option<i32> The 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 to FormatVersion_v2]
message_type Option<String> How the message should be formatted. [default to MessageType_Classic]
timestamp_format Option<String> A timestamp format
compression_codec Option<String> The 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.
period Option<i32> How frequently log files are finalized so they can be available for reading (in seconds). [default to 3600]
gzip_level Option<i32> The 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 to 0]
address Option<String> An hostname or IPv4 address.
hostname Option<String> Hostname used.
ipv4 Option<String> IPv4 address of the host.
password Option<String> The password for the server. For anonymous use an email address.
path Option<String> The path to upload log files to. If the path ends in / then it is treated as a directory.
public_key Option<String> A PGP public key that Fastly will use to encrypt your log files before writing them to disk. [default to null]
user Option<String> The username for the server. Can be anonymous.
port Option<i32> The port number. [default to 21]

Return type

crate::models::LoggingFtpResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

delete_log_ftp

Delete the FTP for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteLogFtpParams {
    // parameters
};
delete_log_ftp(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_ftp_name String The name for the real-time logging configuration. [required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

get_log_ftp

Get the FTP for a particular service and version.

let cfg = &Configuration::default();
let params = GetLogFtpParams {
    // parameters
};
get_log_ftp(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_ftp_name String The name for the real-time logging configuration. [required]

Return type

crate::models::LoggingFtpResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

list_log_ftp

List all of the FTPs for a particular service and version.

let cfg = &Configuration::default();
let params = ListLogFtpParams {
    // parameters
};
list_log_ftp(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]

Return type

Vec<crate::models::LoggingFtpResponse>

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

update_log_ftp

Update the FTP for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogFtpParams {
    // parameters
};
update_log_ftp(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_ftp_name String The name for the real-time logging configuration. [required]
name Option<String> The name for the real-time logging configuration.
placement Option<String> Where 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.
response_condition Option<String> The name of an existing condition in the configured endpoint, or leave blank to always execute.
format Option<String> A Fastly log format string. [default to %h %l %u %t "%r" %>s %b]
format_version Option<i32> The 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 to FormatVersion_v2]
message_type Option<String> How the message should be formatted. [default to MessageType_Classic]
timestamp_format Option<String> A timestamp format
compression_codec Option<String> The 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.
period Option<i32> How frequently log files are finalized so they can be available for reading (in seconds). [default to 3600]
gzip_level Option<i32> The 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 to 0]
address Option<String> An hostname or IPv4 address.
hostname Option<String> Hostname used.
ipv4 Option<String> IPv4 address of the host.
password Option<String> The password for the server. For anonymous use an email address.
path Option<String> The path to upload log files to. If the path ends in / then it is treated as a directory.
public_key Option<String> A PGP public key that Fastly will use to encrypt your log files before writing them to disk. [default to null]
user Option<String> The username for the server. Can be anonymous.
port Option<i32> The port number. [default to 21]

Return type

crate::models::LoggingFtpResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]