Skip to content

Latest commit

 

History

History
211 lines (137 loc) · 8 KB

LoggingHerokuApi.md

File metadata and controls

211 lines (137 loc) · 8 KB

LoggingHerokuApi

Note

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

Method HTTP request Description
create_log_heroku POST /service/{service_id}/version/{version_id}/logging/heroku Create a Heroku log endpoint
delete_log_heroku DELETE /service/{service_id}/version/{version_id}/logging/heroku/{logging_heroku_name} Delete the Heroku log endpoint
get_log_heroku GET /service/{service_id}/version/{version_id}/logging/heroku/{logging_heroku_name} Get a Heroku log endpoint
list_log_heroku GET /service/{service_id}/version/{version_id}/logging/heroku List Heroku log endpoints
update_log_heroku PUT /service/{service_id}/version/{version_id}/logging/heroku/{logging_heroku_name} Update the Heroku log endpoint

create_log_heroku

Create a Heroku for a particular service and version.

let cfg = &Configuration::default();
let params = CreateLogHerokuParams {
    // parameters
};
create_log_heroku(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]
token Option<String> The token to use for authentication (https://devcenter.heroku.com/articles/add-on-partner-log-integration).
url Option<String> The URL to stream logs to.

Return type

crate::models::LoggingHerokuResponse

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_heroku

Delete the Heroku for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteLogHerokuParams {
    // parameters
};
delete_log_heroku(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_heroku_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_heroku

Get the Heroku for a particular service and version.

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

Return type

crate::models::LoggingHerokuResponse

Authorization

token

HTTP request headers

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

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

list_log_heroku

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

let cfg = &Configuration::default();
let params = ListLogHerokuParams {
    // parameters
};
list_log_heroku(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::LoggingHerokuResponse>

Authorization

token

HTTP request headers

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

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

update_log_heroku

Update the Heroku for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogHerokuParams {
    // parameters
};
update_log_heroku(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_heroku_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]
token Option<String> The token to use for authentication (https://devcenter.heroku.com/articles/add-on-partner-log-integration).
url Option<String> The URL to stream logs to.

Return type

crate::models::LoggingHerokuResponse

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]