use WebService::Fastly::Object::LoggingSftpApi;Note
All URIs are relative to https://api.fastly.com
| Method | HTTP request | Description |
|---|---|---|
| create_log_sftp | POST /service/{service_id}/version/{version_id}/logging/sftp | Create an SFTP log endpoint |
| delete_log_sftp | DELETE /service/{service_id}/version/{version_id}/logging/sftp/{logging_sftp_name} | Delete an SFTP log endpoint |
| get_log_sftp | GET /service/{service_id}/version/{version_id}/logging/sftp/{logging_sftp_name} | Get an SFTP log endpoint |
| list_log_sftp | GET /service/{service_id}/version/{version_id}/logging/sftp | List SFTP log endpoints |
| update_log_sftp | PUT /service/{service_id}/version/{version_id}/logging/sftp/{logging_sftp_name} | Update an SFTP log endpoint |
LoggingSftpResponse create_log_sftp(service_id => $service_id, version_id => $version_id, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, address => $address, port => $port, password => $password, path => $path, public_key => $public_key, secret_key => $secret_key, ssh_known_hosts => $ssh_known_hosts, user => $user)
Create an SFTP log endpoint
Create a SFTP for a particular service and version.
use Data::Dumper;
use WebService::Fastly::LoggingSftpApi;
my $api_instance = WebService::Fastly::LoggingSftpApi->new(
# Configure API key authorization: token
api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $name = "name_example"; # string | The name for the real-time logging configuration.
my $placement = "placement_example"; # 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`.
my $response_condition = "response_condition_example"; # string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
my $format = '%h %l %u %t "%r" %>s %b'; # string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
my $format_version = 2; # int | 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`.
my $message_type = 'classic'; # string | How the message should be formatted.
my $timestamp_format = "timestamp_format_example"; # string | A timestamp format
my $compression_codec = "compression_codec_example"; # 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.
my $period = 3600; # int | How frequently log files are finalized so they can be available for reading (in seconds).
my $gzip_level = 0; # int | 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.
my $address = "address_example"; # string | A hostname or IPv4 address.
my $port = 22; # int | The port number.
my $password = "password_example"; # string | The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.
my $path = 'null'; # string | The path to upload logs to.
my $public_key = 'null'; # string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
my $secret_key = 'null'; # string | The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.
my $ssh_known_hosts = "ssh_known_hosts_example"; # string | A list of host keys for all hosts we can connect to over SFTP.
my $user = "user_example"; # string | The username for the server.
eval {
my $result = $api_instance->create_log_sftp(service_id => $service_id, version_id => $version_id, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, address => $address, port => $port, password => $password, path => $path, public_key => $public_key, secret_key => $secret_key, ssh_known_hosts => $ssh_known_hosts, user => $user);
print Dumper($result);
};
if ($@) {
warn "Exception when calling LoggingSftpApi->create_log_sftp: $@\n";
}| Name | Type | Description | Notes |
|---|---|---|---|
| service_id | string | Alphanumeric string identifying the service. | |
| version_id | int | Integer identifying a service version. | |
| name | string | The name for the real-time logging configuration. | [optional] |
| placement | 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. |
[optional] |
| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
| format | string | A Fastly log format string. | [optional] [default to '%h %l %u %t "%r" %>s %b'] |
| format_version | int | 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. |
[optional] [default to 2] |
| message_type | string | How the message should be formatted. | [optional] [default to 'classic'] |
| timestamp_format | string | A timestamp format | [optional] |
| compression_codec | 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. |
[optional] |
| period | int | How frequently log files are finalized so they can be available for reading (in seconds). | [optional] [default to 3600] |
| gzip_level | int | 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. |
[optional] [default to 0] |
| address | string | A hostname or IPv4 address. | [optional] |
| port | int | The port number. | [optional] [default to 22] |
| password | string | The password for the server. If both password and secret_key are passed, secret_key will be used in preference. |
[optional] |
| path | string | The path to upload logs to. | [optional] [default to 'null'] |
| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. | [optional] [default to 'null'] |
| secret_key | string | The SSH private key for the server. If both password and secret_key are passed, secret_key will be used in preference. |
[optional] [default to 'null'] |
| ssh_known_hosts | string | A list of host keys for all hosts we can connect to over SFTP. | [optional] |
| user | string | The username for the server. | [optional] |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 delete_log_sftp(service_id => $service_id, version_id => $version_id, logging_sftp_name => $logging_sftp_name)
Delete an SFTP log endpoint
Delete the SFTP for a particular service and version.
use Data::Dumper;
use WebService::Fastly::LoggingSftpApi;
my $api_instance = WebService::Fastly::LoggingSftpApi->new(
# Configure API key authorization: token
api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_sftp_name = "logging_sftp_name_example"; # string | The name for the real-time logging configuration.
eval {
my $result = $api_instance->delete_log_sftp(service_id => $service_id, version_id => $version_id, logging_sftp_name => $logging_sftp_name);
print Dumper($result);
};
if ($@) {
warn "Exception when calling LoggingSftpApi->delete_log_sftp: $@\n";
}| Name | Type | Description | Notes |
|---|---|---|---|
| service_id | string | Alphanumeric string identifying the service. | |
| version_id | int | Integer identifying a service version. | |
| logging_sftp_name | string | The name for the real-time logging configuration. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoggingSftpResponse get_log_sftp(service_id => $service_id, version_id => $version_id, logging_sftp_name => $logging_sftp_name)
Get an SFTP log endpoint
Get the SFTP for a particular service and version.
use Data::Dumper;
use WebService::Fastly::LoggingSftpApi;
my $api_instance = WebService::Fastly::LoggingSftpApi->new(
# Configure API key authorization: token
api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_sftp_name = "logging_sftp_name_example"; # string | The name for the real-time logging configuration.
eval {
my $result = $api_instance->get_log_sftp(service_id => $service_id, version_id => $version_id, logging_sftp_name => $logging_sftp_name);
print Dumper($result);
};
if ($@) {
warn "Exception when calling LoggingSftpApi->get_log_sftp: $@\n";
}| Name | Type | Description | Notes |
|---|---|---|---|
| service_id | string | Alphanumeric string identifying the service. | |
| version_id | int | Integer identifying a service version. | |
| logging_sftp_name | string | The name for the real-time logging configuration. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ARRAY[LoggingSftpResponse] list_log_sftp(service_id => $service_id, version_id => $version_id)
List SFTP log endpoints
List all of the SFTPs for a particular service and version.
use Data::Dumper;
use WebService::Fastly::LoggingSftpApi;
my $api_instance = WebService::Fastly::LoggingSftpApi->new(
# Configure API key authorization: token
api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
eval {
my $result = $api_instance->list_log_sftp(service_id => $service_id, version_id => $version_id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling LoggingSftpApi->list_log_sftp: $@\n";
}| Name | Type | Description | Notes |
|---|---|---|---|
| service_id | string | Alphanumeric string identifying the service. | |
| version_id | int | Integer identifying a service version. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoggingSftpResponse update_log_sftp(service_id => $service_id, version_id => $version_id, logging_sftp_name => $logging_sftp_name, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, address => $address, port => $port, password => $password, path => $path, public_key => $public_key, secret_key => $secret_key, ssh_known_hosts => $ssh_known_hosts, user => $user)
Update an SFTP log endpoint
Update the SFTP for a particular service and version.
use Data::Dumper;
use WebService::Fastly::LoggingSftpApi;
my $api_instance = WebService::Fastly::LoggingSftpApi->new(
# Configure API key authorization: token
api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_sftp_name = "logging_sftp_name_example"; # string | The name for the real-time logging configuration.
my $name = "name_example"; # string | The name for the real-time logging configuration.
my $placement = "placement_example"; # 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`.
my $response_condition = "response_condition_example"; # string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
my $format = '%h %l %u %t "%r" %>s %b'; # string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
my $format_version = 2; # int | 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`.
my $message_type = 'classic'; # string | How the message should be formatted.
my $timestamp_format = "timestamp_format_example"; # string | A timestamp format
my $compression_codec = "compression_codec_example"; # 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.
my $period = 3600; # int | How frequently log files are finalized so they can be available for reading (in seconds).
my $gzip_level = 0; # int | 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.
my $address = "address_example"; # string | A hostname or IPv4 address.
my $port = 22; # int | The port number.
my $password = "password_example"; # string | The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.
my $path = 'null'; # string | The path to upload logs to.
my $public_key = 'null'; # string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
my $secret_key = 'null'; # string | The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.
my $ssh_known_hosts = "ssh_known_hosts_example"; # string | A list of host keys for all hosts we can connect to over SFTP.
my $user = "user_example"; # string | The username for the server.
eval {
my $result = $api_instance->update_log_sftp(service_id => $service_id, version_id => $version_id, logging_sftp_name => $logging_sftp_name, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, address => $address, port => $port, password => $password, path => $path, public_key => $public_key, secret_key => $secret_key, ssh_known_hosts => $ssh_known_hosts, user => $user);
print Dumper($result);
};
if ($@) {
warn "Exception when calling LoggingSftpApi->update_log_sftp: $@\n";
}| Name | Type | Description | Notes |
|---|---|---|---|
| service_id | string | Alphanumeric string identifying the service. | |
| version_id | int | Integer identifying a service version. | |
| logging_sftp_name | string | The name for the real-time logging configuration. | |
| name | string | The name for the real-time logging configuration. | [optional] |
| placement | 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. |
[optional] |
| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
| format | string | A Fastly log format string. | [optional] [default to '%h %l %u %t "%r" %>s %b'] |
| format_version | int | 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. |
[optional] [default to 2] |
| message_type | string | How the message should be formatted. | [optional] [default to 'classic'] |
| timestamp_format | string | A timestamp format | [optional] |
| compression_codec | 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. |
[optional] |
| period | int | How frequently log files are finalized so they can be available for reading (in seconds). | [optional] [default to 3600] |
| gzip_level | int | 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. |
[optional] [default to 0] |
| address | string | A hostname or IPv4 address. | [optional] |
| port | int | The port number. | [optional] [default to 22] |
| password | string | The password for the server. If both password and secret_key are passed, secret_key will be used in preference. |
[optional] |
| path | string | The path to upload logs to. | [optional] [default to 'null'] |
| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. | [optional] [default to 'null'] |
| secret_key | string | The SSH private key for the server. If both password and secret_key are passed, secret_key will be used in preference. |
[optional] [default to 'null'] |
| ssh_known_hosts | string | A list of host keys for all hosts we can connect to over SFTP. | [optional] |
| user | string | The username for the server. | [optional] |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]