Skip to content

Latest commit

 

History

History
229 lines (155 loc) · 9.96 KB

LoggingSyslogApi.md

File metadata and controls

229 lines (155 loc) · 9.96 KB
Raw

LoggingSyslogApi

Note

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

Method HTTP request Description
create_log_syslog POST /service/{service_id}/version/{version_id}/logging/syslog Create a syslog log endpoint
delete_log_syslog DELETE /service/{service_id}/version/{version_id}/logging/syslog/{logging_syslog_name} Delete a syslog log endpoint
get_log_syslog GET /service/{service_id}/version/{version_id}/logging/syslog/{logging_syslog_name} Get a syslog log endpoint
list_log_syslog GET /service/{service_id}/version/{version_id}/logging/syslog List Syslog log endpoints
update_log_syslog PUT /service/{service_id}/version/{version_id}/logging/syslog/{logging_syslog_name} Update a syslog log endpoint

create_log_syslog

Create a Syslog for a particular service and version.

let cfg = &Configuration::default();
let params = CreateLogSyslogParams {
    // parameters
};
create_log_syslog(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]
tls_ca_cert Option<String> A secure certificate to authenticate a server with. Must be in PEM format. [default to null]
tls_client_cert Option<String> The client certificate used to make authenticated requests. Must be in PEM format. [default to null]
tls_client_key Option<String> The client private key used to make authenticated requests. Must be in PEM format. [default to null]
tls_hostname Option<String> The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. [default to null]
address Option<String> A hostname or IPv4 address.
port Option<i32> The port number. [default to 514]
message_type Option<crate::models::LoggingMessageType>
hostname Option<String> The hostname used for the syslog endpoint.
ipv4 Option<String> The IPv4 address used for the syslog endpoint.
token Option<String> Whether to prepend each message with a specific token. [default to null]
use_tls Option<crate::models::LoggingUseTlsString>

Return type

crate::models::LoggingSyslogResponse

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_syslog

Delete the Syslog for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteLogSyslogParams {
    // parameters
};
delete_log_syslog(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_syslog_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_syslog

Get the Syslog for a particular service and version.

let cfg = &Configuration::default();
let params = GetLogSyslogParams {
    // parameters
};
get_log_syslog(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_syslog_name String The name for the real-time logging configuration. [required]

Return type

crate::models::LoggingSyslogResponse

Authorization

token

HTTP request headers

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

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

list_log_syslog

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

let cfg = &Configuration::default();
let params = ListLogSyslogParams {
    // parameters
};
list_log_syslog(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::LoggingSyslogResponse>

Authorization

token

HTTP request headers

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

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

update_log_syslog

Update the Syslog for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogSyslogParams {
    // parameters
};
update_log_syslog(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_syslog_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]
tls_ca_cert Option<String> A secure certificate to authenticate a server with. Must be in PEM format. [default to null]
tls_client_cert Option<String> The client certificate used to make authenticated requests. Must be in PEM format. [default to null]
tls_client_key Option<String> The client private key used to make authenticated requests. Must be in PEM format. [default to null]
tls_hostname Option<String> The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. [default to null]
address Option<String> A hostname or IPv4 address.
port Option<i32> The port number. [default to 514]
message_type Option<crate::models::LoggingMessageType>
hostname Option<String> The hostname used for the syslog endpoint.
ipv4 Option<String> The IPv4 address used for the syslog endpoint.
token Option<String> Whether to prepend each message with a specific token. [default to null]
use_tls Option<crate::models::LoggingUseTlsString>

Return type

crate::models::LoggingSyslogResponse

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]