LoggingLogshuttleAPI

Note

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

Method	HTTP request	Description
CreateLogLogshuttle	POST `/service/{service_id}/version/{version_id}/logging/logshuttle`	Create a Log Shuttle log endpoint
DeleteLogLogshuttle	DELETE `/service/{service_id}/version/{version_id}/logging/logshuttle/{logging_logshuttle_name}`	Delete a Log Shuttle log endpoint
GetLogLogshuttle	GET `/service/{service_id}/version/{version_id}/logging/logshuttle/{logging_logshuttle_name}`	Get a Log Shuttle log endpoint
ListLogLogshuttle	GET `/service/{service_id}/version/{version_id}/logging/logshuttle`	List Log Shuttle log endpoints
UpdateLogLogshuttle	PUT `/service/{service_id}/version/{version_id}/logging/logshuttle/{logging_logshuttle_name}`	Update a Log Shuttle log endpoint

CreateLogLogshuttle

Create a Log Shuttle log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    name := "name_example" // string | The name for the real-time logging configuration. (optional)
    placement := "placement_example" // 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`.  (optional)
    responseCondition := "responseCondition_example" // string | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format := "format_example" // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) (default to "%h %l %u %t \"%r\" %&gt;s %b")
    formatVersion := int32(56) // int32 | 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) (default to 2)
    token := "token_example" // string | The data authentication token associated with this endpoint. (optional)
    url := "url_example" // string | The URL to stream logs to. (optional)

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingLogshuttleAPI.CreateLogLogshuttle(ctx, serviceID, versionID).Name(name).Placement(placement).ResponseCondition(responseCondition).Format(format).FormatVersion(formatVersion).Token(token).URL(url).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingLogshuttleAPI.CreateLogLogshuttle`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLogLogshuttle`: LoggingLogshuttleResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingLogshuttleAPI.CreateLogLogshuttle`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.

Other Parameters

Other parameters are passed through a pointer to a apiCreateLogLogshuttleRequest struct via the builder pattern

Name	Type	Description	Notes
name	string	The name for the real-time logging configuration.	placement

Return type

LoggingLogshuttleResponse

Authorization

API Token

HTTP request headers

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

Back to top | Back to API list | Back to README

DeleteLogLogshuttle

Delete a Log Shuttle log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingLogshuttleName := "loggingLogshuttleName_example" // string | The name for the real-time logging configuration.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingLogshuttleAPI.DeleteLogLogshuttle(ctx, serviceID, versionID, loggingLogshuttleName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingLogshuttleAPI.DeleteLogLogshuttle`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteLogLogshuttle`: InlineResponse200
    fmt.Fprintf(os.Stdout, "Response from `LoggingLogshuttleAPI.DeleteLogLogshuttle`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingLogshuttleName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLogLogshuttleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

InlineResponse200

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

GetLogLogshuttle

Get a Log Shuttle log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingLogshuttleName := "loggingLogshuttleName_example" // string | The name for the real-time logging configuration.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingLogshuttleAPI.GetLogLogshuttle(ctx, serviceID, versionID, loggingLogshuttleName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingLogshuttleAPI.GetLogLogshuttle`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogLogshuttle`: LoggingLogshuttleResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingLogshuttleAPI.GetLogLogshuttle`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingLogshuttleName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiGetLogLogshuttleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

LoggingLogshuttleResponse

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

ListLogLogshuttle

List Log Shuttle log endpoints

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingLogshuttleAPI.ListLogLogshuttle(ctx, serviceID, versionID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingLogshuttleAPI.ListLogLogshuttle`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListLogLogshuttle`: []LoggingLogshuttleResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingLogshuttleAPI.ListLogLogshuttle`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.

Other Parameters

Other parameters are passed through a pointer to a apiListLogLogshuttleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]LoggingLogshuttleResponse

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

UpdateLogLogshuttle

Update a Log Shuttle log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingLogshuttleName := "loggingLogshuttleName_example" // string | The name for the real-time logging configuration.
    name := "name_example" // string | The name for the real-time logging configuration. (optional)
    placement := "placement_example" // 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`.  (optional)
    responseCondition := "responseCondition_example" // string | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format := "format_example" // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) (default to "%h %l %u %t \"%r\" %&gt;s %b")
    formatVersion := int32(56) // int32 | 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) (default to 2)
    token := "token_example" // string | The data authentication token associated with this endpoint. (optional)
    url := "url_example" // string | The URL to stream logs to. (optional)

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingLogshuttleAPI.UpdateLogLogshuttle(ctx, serviceID, versionID, loggingLogshuttleName).Name(name).Placement(placement).ResponseCondition(responseCondition).Format(format).FormatVersion(formatVersion).Token(token).URL(url).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingLogshuttleAPI.UpdateLogLogshuttle`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateLogLogshuttle`: LoggingLogshuttleResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingLogshuttleAPI.UpdateLogLogshuttle`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingLogshuttleName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateLogLogshuttleRequest struct via the builder pattern

Name	Type	Description	Notes
name	string	The name for the real-time logging configuration.	placement

Return type

LoggingLogshuttleResponse

Authorization

API Token

HTTP request headers

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

Back to top | Back to API list | Back to README

Files

LoggingLogshuttleAPI.md

Latest commit

History

LoggingLogshuttleAPI.md

File metadata and controls

LoggingLogshuttleAPI

CreateLogLogshuttle

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteLogLogshuttle

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetLogLogshuttle

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListLogLogshuttle

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateLogLogshuttle

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers