fastly.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

LoggingHerokuResponse create_log_heroku(service_id, version_id)

Create a Heroku log endpoint

Create a Heroku for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_heroku_api
from fastly.model.logging_heroku_response import LoggingHerokuResponse
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_heroku_api.LoggingHerokuApi(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
    token = "token_example" # str | The token to use for authentication ([https://devcenter.heroku.com/articles/add-on-partner-log-integration](https://devcenter.heroku.com/articles/add-on-partner-log-integration)). (optional)
    url = "url_example" # str | The URL to stream logs to. (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a Heroku log endpoint
        api_response = api_instance.create_log_heroku(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, token=token, url=url)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHerokuApi->create_log_heroku: %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
token	str	The token to use for authentication (https://devcenter.heroku.com/articles/add-on-partner-log-integration).	[optional]
url	str	The URL to stream logs to.	[optional]

Return type

LoggingHerokuResponse

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_heroku

InlineResponse200 delete_log_heroku(service_id, version_id, logging_heroku_name)

Delete the Heroku log endpoint

Delete the Heroku for a particular service and version.

Example

Api Key Authentication (token):

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

Parameters

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

LoggingHerokuResponse get_log_heroku(service_id, version_id, logging_heroku_name)

Get a Heroku log endpoint

Get the Heroku for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_heroku_api
from fastly.model.logging_heroku_response import LoggingHerokuResponse
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_heroku_api.LoggingHerokuApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_heroku_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 Heroku log endpoint
        api_response = api_instance.get_log_heroku(service_id, version_id, logging_heroku_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHerokuApi->get_log_heroku: %s\n" % e)

Parameters

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

Return type

LoggingHerokuResponse

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_heroku

[LoggingHerokuResponse] list_log_heroku(service_id, version_id)

List Heroku log endpoints

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_heroku_api
from fastly.model.logging_heroku_response import LoggingHerokuResponse
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_heroku_api.LoggingHerokuApi(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 Heroku log endpoints
        api_response = api_instance.list_log_heroku(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHerokuApi->list_log_heroku: %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

[LoggingHerokuResponse]

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_heroku

LoggingHerokuResponse update_log_heroku(service_id, version_id, logging_heroku_name)

Update the Heroku log endpoint

Update the Heroku for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_heroku_api
from fastly.model.logging_heroku_response import LoggingHerokuResponse
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_heroku_api.LoggingHerokuApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_heroku_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
    token = "token_example" # str | The token to use for authentication ([https://devcenter.heroku.com/articles/add-on-partner-log-integration](https://devcenter.heroku.com/articles/add-on-partner-log-integration)). (optional)
    url = "url_example" # str | The URL to stream logs to. (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update the Heroku log endpoint
        api_response = api_instance.update_log_heroku(service_id, version_id, logging_heroku_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, token=token, url=url)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingHerokuApi->update_log_heroku: %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_heroku_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
token	str	The token to use for authentication (https://devcenter.heroku.com/articles/add-on-partner-log-integration).	[optional]
url	str	The URL to stream logs to.	[optional]

Return type

LoggingHerokuResponse

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

LoggingHerokuApi.md

Latest commit

History

LoggingHerokuApi.md

File metadata and controls

fastly.LoggingHerokuApi

create_log_heroku

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_log_heroku

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_log_heroku

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_log_heroku

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_log_heroku

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details