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 |
LoggingFtpResponse create_log_ftp(service_id, version_id)
Create an FTP log endpoint
Create a FTP for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_ftp_api
from fastly.model.logging_ftp_response import LoggingFtpResponse
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_ftp_api.LoggingFtpApi(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" %>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" %>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 = "address_example" # str | An hostname or IPv4 address. (optional)
hostname = "hostname_example" # str | Hostname used. (optional)
ipv4 = "ipv4_example" # str | IPv4 address of the host. (optional)
password = "password_example" # str | The password for the server. For anonymous use an email address. (optional)
path = "path_example" # str | The path to upload log files to. If the path ends in `/` then it is treated as a directory. (optional)
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"
user = "user_example" # str | The username for the server. Can be anonymous. (optional)
port = 21 # int | The port number. (optional) if omitted the server will use the default value of 21
# example passing only required values which don't have defaults set
try:
# Create an FTP log endpoint
api_response = api_instance.create_log_ftp(service_id, version_id)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingFtpApi->create_log_ftp: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Create an FTP log endpoint
api_response = api_instance.create_log_ftp(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, hostname=hostname, ipv4=ipv4, password=password, path=path, public_key=public_key, user=user, port=port)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingFtpApi->create_log_ftp: %s\n" % e)
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 | An hostname or IPv4 address. | [optional] |
hostname | str | Hostname used. | [optional] |
ipv4 | str | IPv4 address of the host. | [optional] |
password | str | The password for the server. For anonymous use an email address. | [optional] |
path | str | The path to upload log files to. If the path ends in / then it is treated as a directory. |
[optional] |
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" |
user | str | The username for the server. Can be anonymous. | [optional] |
port | int | The port number. | [optional] if omitted the server will use the default value of 21 |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 delete_log_ftp(service_id, version_id, logging_ftp_name)
Delete an FTP log endpoint
Delete the FTP for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_ftp_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_ftp_api.LoggingFtpApi(api_client)
service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
version_id = 1 # int | Integer identifying a service version.
logging_ftp_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 FTP log endpoint
api_response = api_instance.delete_log_ftp(service_id, version_id, logging_ftp_name)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingFtpApi->delete_log_ftp: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. | |
logging_ftp_name | str | The name for the real-time logging configuration. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoggingFtpResponse get_log_ftp(service_id, version_id, logging_ftp_name)
Get an FTP log endpoint
Get the FTP for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_ftp_api
from fastly.model.logging_ftp_response import LoggingFtpResponse
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_ftp_api.LoggingFtpApi(api_client)
service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
version_id = 1 # int | Integer identifying a service version.
logging_ftp_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 FTP log endpoint
api_response = api_instance.get_log_ftp(service_id, version_id, logging_ftp_name)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingFtpApi->get_log_ftp: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. | |
logging_ftp_name | str | The name for the real-time logging configuration. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[LoggingFtpResponse] list_log_ftp(service_id, version_id)
List FTP log endpoints
List all of the FTPs for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_ftp_api
from fastly.model.logging_ftp_response import LoggingFtpResponse
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_ftp_api.LoggingFtpApi(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 FTP log endpoints
api_response = api_instance.list_log_ftp(service_id, version_id)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingFtpApi->list_log_ftp: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoggingFtpResponse update_log_ftp(service_id, version_id, logging_ftp_name)
Update an FTP log endpoint
Update the FTP for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_ftp_api
from fastly.model.logging_ftp_response import LoggingFtpResponse
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_ftp_api.LoggingFtpApi(api_client)
service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
version_id = 1 # int | Integer identifying a service version.
logging_ftp_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" %>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" %>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 = "address_example" # str | An hostname or IPv4 address. (optional)
hostname = "hostname_example" # str | Hostname used. (optional)
ipv4 = "ipv4_example" # str | IPv4 address of the host. (optional)
password = "password_example" # str | The password for the server. For anonymous use an email address. (optional)
path = "path_example" # str | The path to upload log files to. If the path ends in `/` then it is treated as a directory. (optional)
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"
user = "user_example" # str | The username for the server. Can be anonymous. (optional)
port = 21 # int | The port number. (optional) if omitted the server will use the default value of 21
# example passing only required values which don't have defaults set
try:
# Update an FTP log endpoint
api_response = api_instance.update_log_ftp(service_id, version_id, logging_ftp_name)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingFtpApi->update_log_ftp: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Update an FTP log endpoint
api_response = api_instance.update_log_ftp(service_id, version_id, logging_ftp_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, hostname=hostname, ipv4=ipv4, password=password, path=path, public_key=public_key, user=user, port=port)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingFtpApi->update_log_ftp: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. | |
logging_ftp_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 | An hostname or IPv4 address. | [optional] |
hostname | str | Hostname used. | [optional] |
ipv4 | str | IPv4 address of the host. | [optional] |
password | str | The password for the server. For anonymous use an email address. | [optional] |
path | str | The path to upload log files to. If the path ends in / then it is treated as a directory. |
[optional] |
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" |
user | str | The username for the server. Can be anonymous. | [optional] |
port | int | The port number. | [optional] if omitted the server will use the default value of 21 |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]