Skip to content

Latest commit

 

History

History
211 lines (137 loc) · 7.95 KB

LoggingPapertrailApi.md

File metadata and controls

211 lines (137 loc) · 7.95 KB
Raw

LoggingPapertrailApi

Note

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

Method HTTP request Description
create_log_papertrail POST /service/{service_id}/version/{version_id}/logging/papertrail Create a Papertrail log endpoint
delete_log_papertrail DELETE /service/{service_id}/version/{version_id}/logging/papertrail/{logging_papertrail_name} Delete a Papertrail log endpoint
get_log_papertrail GET /service/{service_id}/version/{version_id}/logging/papertrail/{logging_papertrail_name} Get a Papertrail log endpoint
list_log_papertrail GET /service/{service_id}/version/{version_id}/logging/papertrail List Papertrail log endpoints
update_log_papertrail PUT /service/{service_id}/version/{version_id}/logging/papertrail/{logging_papertrail_name} Update a Papertrail log endpoint

create_log_papertrail

Create a Papertrail for a particular service and version.

let cfg = &Configuration::default();
let params = CreateLogPapertrailParams {
    // parameters
};
create_log_papertrail(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]
address Option<String> A hostname or IPv4 address.
port Option<i32> The port number. [default to 514]

Return type

crate::models::LoggingPapertrailResponse

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_papertrail

Delete the Papertrail for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteLogPapertrailParams {
    // parameters
};
delete_log_papertrail(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_papertrail_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_papertrail

Get the Papertrail for a particular service and version.

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

Return type

crate::models::LoggingPapertrailResponse

Authorization

token

HTTP request headers

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

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

list_log_papertrail

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

let cfg = &Configuration::default();
let params = ListLogPapertrailParams {
    // parameters
};
list_log_papertrail(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::LoggingPapertrailResponse>

Authorization

token

HTTP request headers

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

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

update_log_papertrail

Update the Papertrail for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogPapertrailParams {
    // parameters
};
update_log_papertrail(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_papertrail_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]
address Option<String> A hostname or IPv4 address.
port Option<i32> The port number. [default to 514]

Return type

crate::models::LoggingPapertrailResponse

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]