All URIs are relative to https://api.fastly.com
Method | HTTP request | Description |
---|---|---|
create_log_honeycomb | POST /service/{service_id}/version/{version_id}/logging/honeycomb | Create a Honeycomb log endpoint |
delete_log_honeycomb | DELETE /service/{service_id}/version/{version_id}/logging/honeycomb/{logging_honeycomb_name} | Delete the Honeycomb log endpoint |
get_log_honeycomb | GET /service/{service_id}/version/{version_id}/logging/honeycomb/{logging_honeycomb_name} | Get a Honeycomb log endpoint |
list_log_honeycomb | GET /service/{service_id}/version/{version_id}/logging/honeycomb | List Honeycomb log endpoints |
update_log_honeycomb | PUT /service/{service_id}/version/{version_id}/logging/honeycomb/{logging_honeycomb_name} | Update a Honeycomb log endpoint |
LoggingHoneycombResponse create_log_honeycomb(service_id, version_id)
Create a Honeycomb log endpoint
Create a Honeycomb logging object for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_honeycomb_api
from fastly.model.logging_honeycomb_response import LoggingHoneycombResponse
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_honeycomb_api.LoggingHoneycombApi(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 = "format_example" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Honeycomb can ingest. (optional)
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
dataset = "dataset_example" # str | The Honeycomb Dataset you want to log to. (optional)
token = "token_example" # str | The Write Key from the Account page of your Honeycomb account. (optional)
# example passing only required values which don't have defaults set
try:
# Create a Honeycomb log endpoint
api_response = api_instance.create_log_honeycomb(service_id, version_id)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingHoneycombApi->create_log_honeycomb: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Create a Honeycomb log endpoint
api_response = api_instance.create_log_honeycomb(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, dataset=dataset, token=token)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingHoneycombApi->create_log_honeycomb: %s\n" % e)
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. Must produce valid JSON that Honeycomb can ingest. | [optional] |
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 |
dataset | str | The Honeycomb Dataset you want to log to. | [optional] |
token | str | The Write Key from the Account page of your Honeycomb account. | [optional] |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 delete_log_honeycomb(service_id, version_id, logging_honeycomb_name)
Delete the Honeycomb log endpoint
Delete the Honeycomb logging object for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_honeycomb_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_honeycomb_api.LoggingHoneycombApi(api_client)
service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
version_id = 1 # int | Integer identifying a service version.
logging_honeycomb_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 the Honeycomb log endpoint
api_response = api_instance.delete_log_honeycomb(service_id, version_id, logging_honeycomb_name)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingHoneycombApi->delete_log_honeycomb: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. | |
logging_honeycomb_name | str | The name for the real-time logging configuration. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoggingHoneycombResponse get_log_honeycomb(service_id, version_id, logging_honeycomb_name)
Get a Honeycomb log endpoint
Get the details of a Honeycomb logging object for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_honeycomb_api
from fastly.model.logging_honeycomb_response import LoggingHoneycombResponse
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_honeycomb_api.LoggingHoneycombApi(api_client)
service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
version_id = 1 # int | Integer identifying a service version.
logging_honeycomb_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 Honeycomb log endpoint
api_response = api_instance.get_log_honeycomb(service_id, version_id, logging_honeycomb_name)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingHoneycombApi->get_log_honeycomb: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. | |
logging_honeycomb_name | str | The name for the real-time logging configuration. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[LoggingHoneycombResponse] list_log_honeycomb(service_id, version_id)
List Honeycomb log endpoints
List all of the Honeycomb logging objects for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_honeycomb_api
from fastly.model.logging_honeycomb_response import LoggingHoneycombResponse
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_honeycomb_api.LoggingHoneycombApi(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 Honeycomb log endpoints
api_response = api_instance.list_log_honeycomb(service_id, version_id)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingHoneycombApi->list_log_honeycomb: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoggingHoneycombResponse update_log_honeycomb(service_id, version_id, logging_honeycomb_name)
Update a Honeycomb log endpoint
Update a Honeycomb logging object for a particular service and version.
- Api Key Authentication (token):
import time
import fastly
from fastly.api import logging_honeycomb_api
from fastly.model.logging_honeycomb_response import LoggingHoneycombResponse
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_honeycomb_api.LoggingHoneycombApi(api_client)
service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
version_id = 1 # int | Integer identifying a service version.
logging_honeycomb_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 = "format_example" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Honeycomb can ingest. (optional)
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
dataset = "dataset_example" # str | The Honeycomb Dataset you want to log to. (optional)
token = "token_example" # str | The Write Key from the Account page of your Honeycomb account. (optional)
# example passing only required values which don't have defaults set
try:
# Update a Honeycomb log endpoint
api_response = api_instance.update_log_honeycomb(service_id, version_id, logging_honeycomb_name)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingHoneycombApi->update_log_honeycomb: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Update a Honeycomb log endpoint
api_response = api_instance.update_log_honeycomb(service_id, version_id, logging_honeycomb_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, dataset=dataset, token=token)
pprint(api_response)
except fastly.ApiException as e:
print("Exception when calling LoggingHoneycombApi->update_log_honeycomb: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
service_id | str | Alphanumeric string identifying the service. | |
version_id | int | Integer identifying a service version. | |
logging_honeycomb_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. Must produce valid JSON that Honeycomb can ingest. | [optional] |
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 |
dataset | str | The Honeycomb Dataset you want to log to. | [optional] |
token | str | The Write Key from the Account page of your Honeycomb account. | [optional] |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]