LoggingFtpAPI

Note

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

Method	HTTP request	Description
CreateLogFtp	POST `/service/{service_id}/version/{version_id}/logging/ftp`	Create an FTP log endpoint
DeleteLogFtp	DELETE `/service/{service_id}/version/{version_id}/logging/ftp/{logging_ftp_name}`	Delete an FTP log endpoint
GetLogFtp	GET `/service/{service_id}/version/{version_id}/logging/ftp/{logging_ftp_name}`	Get an FTP log endpoint
ListLogFtp	GET `/service/{service_id}/version/{version_id}/logging/ftp`	List FTP log endpoints
UpdateLogFtp	PUT `/service/{service_id}/version/{version_id}/logging/ftp/{logging_ftp_name}`	Update an FTP log endpoint

CreateLogFtp

Create an FTP log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    name := "name_example" // string | The name for the real-time logging configuration. (optional)
    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`.  (optional)
    responseCondition := "responseCondition_example" // string | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format := "format_example" // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) (default to "%h %l %u %t \"%r\" %&gt;s %b")
    formatVersion := int32(56) // int32 | 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)
    messageType := "messageType_example" // string | How the message should be formatted. (optional) (default to "classic")
    timestampFormat := "timestampFormat_example" // string | A timestamp format (optional)
    compressionCodec := "compressionCodec_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. (optional)
    period := int32(56) // int32 | How frequently log files are finalized so they can be available for reading (in seconds). (optional) (default to 3600)
    gzipLevel := int32(56) // int32 | 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 := "address_example" // string | An hostname or IPv4 address. (optional)
    hostname := "hostname_example" // string | Hostname used. (optional)
    ipv4 := "ipv4_example" // string | IPv4 address of the host. (optional)
    password := "password_example" // string | The password for the server. For anonymous use an email address. (optional)
    path := "path_example" // string | The path to upload log files to. If the path ends in `/` then it is treated as a directory. (optional)
    publicKey := "publicKey_example" // string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (optional) (default to "null")
    user := "user_example" // string | The username for the server. Can be anonymous. (optional)
    port := int32(56) // int32 | The port number. (optional) (default to 21)

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingFtpAPI.CreateLogFtp(ctx, serviceID, versionID).Name(name).Placement(placement).ResponseCondition(responseCondition).Format(format).FormatVersion(formatVersion).MessageType(messageType).TimestampFormat(timestampFormat).CompressionCodec(compressionCodec).Period(period).GzipLevel(gzipLevel).Address(address).Hostname(hostname).Ipv4(ipv4).Password(password).Path(path).PublicKey(publicKey).User(user).Port(port).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingFtpAPI.CreateLogFtp`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLogFtp`: LoggingFtpResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingFtpAPI.CreateLogFtp`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.

Other Parameters

Other parameters are passed through a pointer to a apiCreateLogFtpRequest struct via the builder pattern

Name	Type	Description	Notes
name	string	The name for the real-time logging configuration.	placement

Return type

LoggingFtpResponse

Authorization

API Token

HTTP request headers

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

Back to top | Back to API list | Back to README

DeleteLogFtp

Delete an FTP log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingFtpName := "loggingFtpName_example" // string | The name for the real-time logging configuration.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingFtpAPI.DeleteLogFtp(ctx, serviceID, versionID, loggingFtpName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingFtpAPI.DeleteLogFtp`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteLogFtp`: InlineResponse200
    fmt.Fprintf(os.Stdout, "Response from `LoggingFtpAPI.DeleteLogFtp`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingFtpName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLogFtpRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

InlineResponse200

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

GetLogFtp

Get an FTP log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingFtpName := "loggingFtpName_example" // string | The name for the real-time logging configuration.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingFtpAPI.GetLogFtp(ctx, serviceID, versionID, loggingFtpName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingFtpAPI.GetLogFtp`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogFtp`: LoggingFtpResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingFtpAPI.GetLogFtp`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingFtpName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiGetLogFtpRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

LoggingFtpResponse

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

ListLogFtp

List FTP log endpoints

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingFtpAPI.ListLogFtp(ctx, serviceID, versionID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingFtpAPI.ListLogFtp`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListLogFtp`: []LoggingFtpResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingFtpAPI.ListLogFtp`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.

Other Parameters

Other parameters are passed through a pointer to a apiListLogFtpRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]LoggingFtpResponse

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

UpdateLogFtp

Update an FTP log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingFtpName := "loggingFtpName_example" // string | The name for the real-time logging configuration.
    name := "name_example" // string | The name for the real-time logging configuration. (optional)
    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`.  (optional)
    responseCondition := "responseCondition_example" // string | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format := "format_example" // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) (default to "%h %l %u %t \"%r\" %&gt;s %b")
    formatVersion := int32(56) // int32 | 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)
    messageType := "messageType_example" // string | How the message should be formatted. (optional) (default to "classic")
    timestampFormat := "timestampFormat_example" // string | A timestamp format (optional)
    compressionCodec := "compressionCodec_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. (optional)
    period := int32(56) // int32 | How frequently log files are finalized so they can be available for reading (in seconds). (optional) (default to 3600)
    gzipLevel := int32(56) // int32 | 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 := "address_example" // string | An hostname or IPv4 address. (optional)
    hostname := "hostname_example" // string | Hostname used. (optional)
    ipv4 := "ipv4_example" // string | IPv4 address of the host. (optional)
    password := "password_example" // string | The password for the server. For anonymous use an email address. (optional)
    path := "path_example" // string | The path to upload log files to. If the path ends in `/` then it is treated as a directory. (optional)
    publicKey := "publicKey_example" // string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (optional) (default to "null")
    user := "user_example" // string | The username for the server. Can be anonymous. (optional)
    port := int32(56) // int32 | The port number. (optional) (default to 21)

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingFtpAPI.UpdateLogFtp(ctx, serviceID, versionID, loggingFtpName).Name(name).Placement(placement).ResponseCondition(responseCondition).Format(format).FormatVersion(formatVersion).MessageType(messageType).TimestampFormat(timestampFormat).CompressionCodec(compressionCodec).Period(period).GzipLevel(gzipLevel).Address(address).Hostname(hostname).Ipv4(ipv4).Password(password).Path(path).PublicKey(publicKey).User(user).Port(port).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingFtpAPI.UpdateLogFtp`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateLogFtp`: LoggingFtpResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingFtpAPI.UpdateLogFtp`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingFtpName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateLogFtpRequest struct via the builder pattern

Name	Type	Description	Notes
name	string	The name for the real-time logging configuration.	placement

Return type

LoggingFtpResponse

Authorization

API Token

HTTP request headers

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

Back to top | Back to API list | Back to README

Files

LoggingFtpAPI.md

Latest commit

History

LoggingFtpAPI.md

File metadata and controls

LoggingFtpAPI

CreateLogFtp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteLogFtp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetLogFtp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListLogFtp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateLogFtp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers