fastly.LoggingHttpsApi

Note

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

Method	HTTP request	Description
create_log_https	POST /service/{service_id}/version/{version_id}/logging/https	Create an HTTPS log endpoint
delete_log_https	DELETE /service/{service_id}/version/{version_id}/logging/https/{logging_https_name}	Delete an HTTPS log endpoint
get_log_https	GET /service/{service_id}/version/{version_id}/logging/https/{logging_https_name}	Get an HTTPS log endpoint
list_log_https	GET /service/{service_id}/version/{version_id}/logging/https	List HTTPS log endpoints
update_log_https	PUT /service/{service_id}/version/{version_id}/logging/https/{logging_https_name}	Update an HTTPS log endpoint

create_log_https

LoggingHttpsResponse create_log_https(service_id, version_id)

Create an HTTPS log endpoint

Create an HTTPS object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_https_api
from fastly.model.logging_message_type import LoggingMessageType
from fastly.model.logging_https_response import LoggingHttpsResponse
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_https_api.LoggingHttpsApi(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" %&gt;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" %&gt;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
    tls_ca_cert = "null" # str, none_type | A secure certificate to authenticate a server with. Must be in PEM format. (optional) if omitted the server will use the default value of "null"
    tls_client_cert = "null" # str, none_type | The client certificate used to make authenticated requests. Must be in PEM format. (optional) if omitted the server will use the default value of "null"
    tls_client_key = "null" # str, none_type | The client private key used to make authenticated requests. Must be in PEM format. (optional) if omitted the server will use the default value of "null"
    tls_hostname = "null" # str, none_type | 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. (optional) if omitted the server will use the default value of "null"
    request_max_entries = 0 # int | The maximum number of logs sent in one request. Defaults `0` (10k). (optional) if omitted the server will use the default value of 0
    request_max_bytes = 0 # int | The maximum number of bytes sent in one request. Defaults `0` (100MB). (optional) if omitted the server will use the default value of 0
    url = "url_example" # str | The URL to send logs to. Must use HTTPS. Required. (optional)
    content_type = "null" # str, none_type | Content type of the header sent with the request. (optional) if omitted the server will use the default value of "null"
    header_name = "null" # str, none_type | Name of the custom header sent with the request. (optional) if omitted the server will use the default value of "null"
    message_type = LoggingMessageType("classic") # LoggingMessageType |  (optional)
    header_value = "null" # str, none_type | Value of the custom header sent with the request. (optional) if omitted the server will use the default value of "null"
    method = "POST" # str | HTTP method used for request. (optional) if omitted the server will use the default value of "POST"
    json_format = "0" # str | Enforces valid JSON formatting for log entries. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create an HTTPS log endpoint
        api_response = api_instance.create_log_https(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHttpsApi->create_log_https: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create an HTTPS log endpoint
        api_response = api_instance.create_log_https(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, tls_ca_cert=tls_ca_cert, tls_client_cert=tls_client_cert, tls_client_key=tls_client_key, tls_hostname=tls_hostname, request_max_entries=request_max_entries, request_max_bytes=request_max_bytes, url=url, content_type=content_type, header_name=header_name, message_type=message_type, header_value=header_value, method=method, json_format=json_format)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHttpsApi->create_log_https: %s\n" % e)

Parameters

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
tls_ca_cert	str, none_type	A secure certificate to authenticate a server with. Must be in PEM format.	[optional] if omitted the server will use the default value of "null"
tls_client_cert	str, none_type	The client certificate used to make authenticated requests. Must be in PEM format.	[optional] if omitted the server will use the default value of "null"
tls_client_key	str, none_type	The client private key used to make authenticated requests. Must be in PEM format.	[optional] if omitted the server will use the default value of "null"
tls_hostname	str, none_type	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.	[optional] if omitted the server will use the default value of "null"
request_max_entries	int	The maximum number of logs sent in one request. Defaults `0` (10k).	[optional] if omitted the server will use the default value of 0
request_max_bytes	int	The maximum number of bytes sent in one request. Defaults `0` (100MB).	[optional] if omitted the server will use the default value of 0
url	str	The URL to send logs to. Must use HTTPS. Required.	[optional]
content_type	str, none_type	Content type of the header sent with the request.	[optional] if omitted the server will use the default value of "null"
header_name	str, none_type	Name of the custom header sent with the request.	[optional] if omitted the server will use the default value of "null"
message_type	LoggingMessageType		[optional]
header_value	str, none_type	Value of the custom header sent with the request.	[optional] if omitted the server will use the default value of "null"
method	str	HTTP method used for request.	[optional] if omitted the server will use the default value of "POST"
json_format	str	Enforces valid JSON formatting for log entries.	[optional]

Return type

LoggingHttpsResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

delete_log_https

InlineResponse200 delete_log_https(service_id, version_id, logging_https_name)

Delete an HTTPS log endpoint

Delete the HTTPS object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_https_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_https_api.LoggingHttpsApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_https_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 HTTPS log endpoint
        api_response = api_instance.delete_log_https(service_id, version_id, logging_https_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHttpsApi->delete_log_https: %s\n" % e)

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_https_name	str	The name for the real-time logging configuration.

Return type

InlineResponse200

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_log_https

LoggingHttpsResponse get_log_https(service_id, version_id, logging_https_name)

Get an HTTPS log endpoint

Get the HTTPS object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_https_api
from fastly.model.logging_https_response import LoggingHttpsResponse
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_https_api.LoggingHttpsApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_https_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 HTTPS log endpoint
        api_response = api_instance.get_log_https(service_id, version_id, logging_https_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHttpsApi->get_log_https: %s\n" % e)

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_https_name	str	The name for the real-time logging configuration.

Return type

LoggingHttpsResponse

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_log_https

[LoggingHttpsResponse] list_log_https(service_id, version_id)

List HTTPS log endpoints

List all of the HTTPS objects for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_https_api
from fastly.model.logging_https_response import LoggingHttpsResponse
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_https_api.LoggingHttpsApi(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 HTTPS log endpoints
        api_response = api_instance.list_log_https(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHttpsApi->list_log_https: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.

Return type

[LoggingHttpsResponse]

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

update_log_https

LoggingHttpsResponse update_log_https(service_id, version_id, logging_https_name)

Update an HTTPS log endpoint

Update the HTTPS object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_https_api
from fastly.model.logging_message_type import LoggingMessageType
from fastly.model.logging_https_response import LoggingHttpsResponse
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_https_api.LoggingHttpsApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_https_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" %&gt;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" %&gt;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
    tls_ca_cert = "null" # str, none_type | A secure certificate to authenticate a server with. Must be in PEM format. (optional) if omitted the server will use the default value of "null"
    tls_client_cert = "null" # str, none_type | The client certificate used to make authenticated requests. Must be in PEM format. (optional) if omitted the server will use the default value of "null"
    tls_client_key = "null" # str, none_type | The client private key used to make authenticated requests. Must be in PEM format. (optional) if omitted the server will use the default value of "null"
    tls_hostname = "null" # str, none_type | 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. (optional) if omitted the server will use the default value of "null"
    request_max_entries = 0 # int | The maximum number of logs sent in one request. Defaults `0` (10k). (optional) if omitted the server will use the default value of 0
    request_max_bytes = 0 # int | The maximum number of bytes sent in one request. Defaults `0` (100MB). (optional) if omitted the server will use the default value of 0
    url = "url_example" # str | The URL to send logs to. Must use HTTPS. Required. (optional)
    content_type = "null" # str, none_type | Content type of the header sent with the request. (optional) if omitted the server will use the default value of "null"
    header_name = "null" # str, none_type | Name of the custom header sent with the request. (optional) if omitted the server will use the default value of "null"
    message_type = LoggingMessageType("classic") # LoggingMessageType |  (optional)
    header_value = "null" # str, none_type | Value of the custom header sent with the request. (optional) if omitted the server will use the default value of "null"
    method = "POST" # str | HTTP method used for request. (optional) if omitted the server will use the default value of "POST"
    json_format = "0" # str | Enforces valid JSON formatting for log entries. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update an HTTPS log endpoint
        api_response = api_instance.update_log_https(service_id, version_id, logging_https_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHttpsApi->update_log_https: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update an HTTPS log endpoint
        api_response = api_instance.update_log_https(service_id, version_id, logging_https_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, tls_ca_cert=tls_ca_cert, tls_client_cert=tls_client_cert, tls_client_key=tls_client_key, tls_hostname=tls_hostname, request_max_entries=request_max_entries, request_max_bytes=request_max_bytes, url=url, content_type=content_type, header_name=header_name, message_type=message_type, header_value=header_value, method=method, json_format=json_format)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHttpsApi->update_log_https: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_https_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
tls_ca_cert	str, none_type	A secure certificate to authenticate a server with. Must be in PEM format.	[optional] if omitted the server will use the default value of "null"
tls_client_cert	str, none_type	The client certificate used to make authenticated requests. Must be in PEM format.	[optional] if omitted the server will use the default value of "null"
tls_client_key	str, none_type	The client private key used to make authenticated requests. Must be in PEM format.	[optional] if omitted the server will use the default value of "null"
tls_hostname	str, none_type	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.	[optional] if omitted the server will use the default value of "null"
request_max_entries	int	The maximum number of logs sent in one request. Defaults `0` (10k).	[optional] if omitted the server will use the default value of 0
request_max_bytes	int	The maximum number of bytes sent in one request. Defaults `0` (100MB).	[optional] if omitted the server will use the default value of 0
url	str	The URL to send logs to. Must use HTTPS. Required.	[optional]
content_type	str, none_type	Content type of the header sent with the request.	[optional] if omitted the server will use the default value of "null"
header_name	str, none_type	Name of the custom header sent with the request.	[optional] if omitted the server will use the default value of "null"
message_type	LoggingMessageType		[optional]
header_value	str, none_type	Value of the custom header sent with the request.	[optional] if omitted the server will use the default value of "null"
method	str	HTTP method used for request.	[optional] if omitted the server will use the default value of "POST"
json_format	str	Enforces valid JSON formatting for log entries.	[optional]

Return type

LoggingHttpsResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Files

LoggingHttpsApi.md

Latest commit

History

LoggingHttpsApi.md

File metadata and controls

fastly.LoggingHttpsApi

create_log_https

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_log_https

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_log_https

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_log_https

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_log_https

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details