fastly.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

create_log_sftp

LoggingSftpResponse create_log_sftp(service_id, version_id)

Create an SFTP log endpoint

Create a SFTP for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_sftp_api
from fastly.model.logging_sftp_response import LoggingSftpResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_sftp_api.LoggingSftpApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    name = "test-log-endpoint" # str | The name for the real-time logging configuration. (optional)
    placement = "none" # str, none_type | 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 = "response_condition_example" # str, none_type | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format = "%h %l %u %t "%r" %&gt;s %b" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) if omitted the server will use the default value of "%h %l %u %t "%r" %&gt;s %b"
    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`.  (optional) if omitted the server will use the default value of 2
    message_type = "classic" # str | How the message should be formatted. (optional) if omitted the server will use the default value of "classic"
    timestamp_format = "%Y-%m-%dT%H:%M:%S.000" # str, none_type | A timestamp format (optional)
    compression_codec = "zstd" # str | 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 = 3600 # int | How frequently log files are finalized so they can be available for reading (in seconds). (optional) if omitted the server will use the default value of 3600
    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. (optional) if omitted the server will use the default value of 0
    address = "example.com" # str | A hostname or IPv4 address. (optional)
    port = 22 # int | The port number. (optional) if omitted the server will use the default value of 22
    password = "password_example" # str | The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. (optional)
    path = "null" # str, none_type | The path to upload logs to. (optional) if omitted the server will use the default value of "null"
    public_key = '''-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
''' # str, none_type | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (optional) if omitted the server will use the default value of "null"
    secret_key = "null" # str, none_type | The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. (optional) if omitted the server will use the default value of "null"
    ssh_known_hosts = "ssh_known_hosts_example" # str | A list of host keys for all hosts we can connect to over SFTP. (optional)
    user = "user_example" # str | The username for the server. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create an SFTP log endpoint
        api_response = api_instance.create_log_sftp(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingSftpApi->create_log_sftp: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create an SFTP log endpoint
        api_response = api_instance.create_log_sftp(service_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)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingSftpApi->create_log_sftp: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
name	str	The name for the real-time logging configuration.	[optional]
placement	str, none_type	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	str, none_type	The name of an existing condition in the configured endpoint, or leave blank to always execute.	[optional]
format	str	A Fastly log format string.	[optional] if omitted the server will use the default value of "%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] if omitted the server will use the default value of 2
message_type	str	How the message should be formatted.	[optional] if omitted the server will use the default value of "classic"
timestamp_format	str, none_type	A timestamp format	[optional]
compression_codec	str	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] if omitted the server will use the default value of 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] if omitted the server will use the default value of 0
address	str	A hostname or IPv4 address.	[optional]
port	int	The port number.	[optional] if omitted the server will use the default value of 22
password	str	The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.	[optional]
path	str, none_type	The path to upload logs to.	[optional] if omitted the server will use the default value of "null"
public_key	str, none_type	A PGP public key that Fastly will use to encrypt your log files before writing them to disk.	[optional] if omitted the server will use the default value of "null"
secret_key	str, none_type	The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.	[optional] if omitted the server will use the default value of "null"
ssh_known_hosts	str	A list of host keys for all hosts we can connect to over SFTP.	[optional]
user	str	The username for the server.	[optional]

Return type

LoggingSftpResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

delete_log_sftp

InlineResponse200 delete_log_sftp(service_id, version_id, logging_sftp_name)

Delete an SFTP log endpoint

Delete the SFTP for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_sftp_api
from fastly.model.inline_response200 import InlineResponse200
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_sftp_api.LoggingSftpApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_sftp_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Delete an SFTP log endpoint
        api_response = api_instance.delete_log_sftp(service_id, version_id, logging_sftp_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingSftpApi->delete_log_sftp: %s\n" % e)

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_sftp_name	str	The name for the real-time logging configuration.

Return type

InlineResponse200

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_log_sftp

LoggingSftpResponse get_log_sftp(service_id, version_id, logging_sftp_name)

Get an SFTP log endpoint

Get the SFTP for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_sftp_api
from fastly.model.logging_sftp_response import LoggingSftpResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_sftp_api.LoggingSftpApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_sftp_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Get an SFTP log endpoint
        api_response = api_instance.get_log_sftp(service_id, version_id, logging_sftp_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingSftpApi->get_log_sftp: %s\n" % e)

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_sftp_name	str	The name for the real-time logging configuration.

Return type

LoggingSftpResponse

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_log_sftp

[LoggingSftpResponse] list_log_sftp(service_id, version_id)

List SFTP log endpoints

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_sftp_api
from fastly.model.logging_sftp_response import LoggingSftpResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_sftp_api.LoggingSftpApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.

    # example passing only required values which don't have defaults set
    try:
        # List SFTP log endpoints
        api_response = api_instance.list_log_sftp(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingSftpApi->list_log_sftp: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.

Return type

[LoggingSftpResponse]

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

update_log_sftp

LoggingSftpResponse update_log_sftp(service_id, version_id, logging_sftp_name)

Update an SFTP log endpoint

Update the SFTP for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_sftp_api
from fastly.model.logging_sftp_response import LoggingSftpResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_sftp_api.LoggingSftpApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_sftp_name = "test-log-endpoint" # str | The name for the real-time logging configuration.
    name = "test-log-endpoint" # str | The name for the real-time logging configuration. (optional)
    placement = "none" # str, none_type | 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 = "response_condition_example" # str, none_type | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format = "%h %l %u %t "%r" %&gt;s %b" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) if omitted the server will use the default value of "%h %l %u %t "%r" %&gt;s %b"
    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`.  (optional) if omitted the server will use the default value of 2
    message_type = "classic" # str | How the message should be formatted. (optional) if omitted the server will use the default value of "classic"
    timestamp_format = "%Y-%m-%dT%H:%M:%S.000" # str, none_type | A timestamp format (optional)
    compression_codec = "zstd" # str | 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 = 3600 # int | How frequently log files are finalized so they can be available for reading (in seconds). (optional) if omitted the server will use the default value of 3600
    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. (optional) if omitted the server will use the default value of 0
    address = "example.com" # str | A hostname or IPv4 address. (optional)
    port = 22 # int | The port number. (optional) if omitted the server will use the default value of 22
    password = "password_example" # str | The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. (optional)
    path = "null" # str, none_type | The path to upload logs to. (optional) if omitted the server will use the default value of "null"
    public_key = '''-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
''' # str, none_type | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (optional) if omitted the server will use the default value of "null"
    secret_key = "null" # str, none_type | The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference. (optional) if omitted the server will use the default value of "null"
    ssh_known_hosts = "ssh_known_hosts_example" # str | A list of host keys for all hosts we can connect to over SFTP. (optional)
    user = "user_example" # str | The username for the server. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update an SFTP log endpoint
        api_response = api_instance.update_log_sftp(service_id, version_id, logging_sftp_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingSftpApi->update_log_sftp: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update an SFTP log endpoint
        api_response = api_instance.update_log_sftp(service_id, version_id, 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)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingSftpApi->update_log_sftp: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_sftp_name	str	The name for the real-time logging configuration.
name	str	The name for the real-time logging configuration.	[optional]
placement	str, none_type	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	str, none_type	The name of an existing condition in the configured endpoint, or leave blank to always execute.	[optional]
format	str	A Fastly log format string.	[optional] if omitted the server will use the default value of "%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] if omitted the server will use the default value of 2
message_type	str	How the message should be formatted.	[optional] if omitted the server will use the default value of "classic"
timestamp_format	str, none_type	A timestamp format	[optional]
compression_codec	str	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] if omitted the server will use the default value of 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] if omitted the server will use the default value of 0
address	str	A hostname or IPv4 address.	[optional]
port	int	The port number.	[optional] if omitted the server will use the default value of 22
password	str	The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.	[optional]
path	str, none_type	The path to upload logs to.	[optional] if omitted the server will use the default value of "null"
public_key	str, none_type	A PGP public key that Fastly will use to encrypt your log files before writing them to disk.	[optional] if omitted the server will use the default value of "null"
secret_key	str, none_type	The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be used in preference.	[optional] if omitted the server will use the default value of "null"
ssh_known_hosts	str	A list of host keys for all hosts we can connect to over SFTP.	[optional]
user	str	The username for the server.	[optional]

Return type

LoggingSftpResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Files

LoggingSftpApi.md

Latest commit

History

LoggingSftpApi.md

File metadata and controls

fastly.LoggingSftpApi

create_log_sftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_log_sftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_log_sftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_log_sftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_log_sftp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details