fastly.LoggingLogentriesApi

Note

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

Method	HTTP request	Description
create_log_logentries	POST /service/{service_id}/version/{version_id}/logging/logentries	Create a Logentries log endpoint
delete_log_logentries	DELETE /service/{service_id}/version/{version_id}/logging/logentries/{logging_logentries_name}	Delete a Logentries log endpoint
get_log_logentries	GET /service/{service_id}/version/{version_id}/logging/logentries/{logging_logentries_name}	Get a Logentries log endpoint
list_log_logentries	GET /service/{service_id}/version/{version_id}/logging/logentries	List Logentries log endpoints
update_log_logentries	PUT /service/{service_id}/version/{version_id}/logging/logentries/{logging_logentries_name}	Update a Logentries log endpoint

create_log_logentries

LoggingLogentriesResponse create_log_logentries(service_id, version_id)

Create a Logentries log endpoint

Create a Logentry for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_logentries_api
from fastly.model.logging_logentries_response import LoggingLogentriesResponse
from fastly.model.logging_use_tls_string import LoggingUseTlsString
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_logentries_api.LoggingLogentriesApi(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
    port = 20000 # int | The port number. (optional) if omitted the server will use the default value of 20000
    token = "token_example" # str | Use token based authentication. (optional)
    use_tls = LoggingUseTlsString("0") # LoggingUseTlsString |  (optional)
    region = "US" # str | The region to which to stream logs. (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a Logentries log endpoint
        api_response = api_instance.create_log_logentries(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, port=port, token=token, use_tls=use_tls, region=region)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingLogentriesApi->create_log_logentries: %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
port	int	The port number.	[optional] if omitted the server will use the default value of 20000
token	str	Use token based authentication.	[optional]
use_tls	LoggingUseTlsString		[optional]
region	str	The region to which to stream logs.	[optional]

Return type

LoggingLogentriesResponse

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_logentries

InlineResponse200 delete_log_logentries(service_id, version_id, logging_logentries_name)

Delete a Logentries log endpoint

Delete the Logentry for a particular service and version.

Example

Api Key Authentication (token):

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

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_logentries_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_logentries

LoggingLogentriesResponse get_log_logentries(service_id, version_id, logging_logentries_name)

Get a Logentries log endpoint

Get the Logentry for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_logentries_api
from fastly.model.logging_logentries_response import LoggingLogentriesResponse
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_logentries_api.LoggingLogentriesApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_logentries_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 a Logentries log endpoint
        api_response = api_instance.get_log_logentries(service_id, version_id, logging_logentries_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingLogentriesApi->get_log_logentries: %s\n" % e)

Parameters

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

Return type

LoggingLogentriesResponse

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_logentries

[LoggingLogentriesResponse] list_log_logentries(service_id, version_id)

List Logentries log endpoints

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_logentries_api
from fastly.model.logging_logentries_response import LoggingLogentriesResponse
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_logentries_api.LoggingLogentriesApi(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 Logentries log endpoints
        api_response = api_instance.list_log_logentries(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingLogentriesApi->list_log_logentries: %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

[LoggingLogentriesResponse]

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_logentries

LoggingLogentriesResponse update_log_logentries(service_id, version_id, logging_logentries_name)

Update a Logentries log endpoint

Update the Logentry for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_logentries_api
from fastly.model.logging_logentries_response import LoggingLogentriesResponse
from fastly.model.logging_use_tls_string import LoggingUseTlsString
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_logentries_api.LoggingLogentriesApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_logentries_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
    port = 20000 # int | The port number. (optional) if omitted the server will use the default value of 20000
    token = "token_example" # str | Use token based authentication. (optional)
    use_tls = LoggingUseTlsString("0") # LoggingUseTlsString |  (optional)
    region = "US" # str | The region to which to stream logs. (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a Logentries log endpoint
        api_response = api_instance.update_log_logentries(service_id, version_id, logging_logentries_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, port=port, token=token, use_tls=use_tls, region=region)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingLogentriesApi->update_log_logentries: %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_logentries_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
port	int	The port number.	[optional] if omitted the server will use the default value of 20000
token	str	Use token based authentication.	[optional]
use_tls	LoggingUseTlsString		[optional]
region	str	The region to which to stream logs.	[optional]

Return type

LoggingLogentriesResponse

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

LoggingLogentriesApi.md

Latest commit

History

LoggingLogentriesApi.md

File metadata and controls

fastly.LoggingLogentriesApi

create_log_logentries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_log_logentries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_log_logentries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_log_logentries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_log_logentries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details