\LogForwardersApi

All URIs are relative to https://napi.arvancloud.ir/cdn/4.0

Method	HTTP request	Description
LogForwardersDestroy	Delete /domains/{domain}/log-forwarders/{logForwarderId}	delete a log forwarder
LogForwardersIndex	Get /domains/{domain}/log-forwarders	Show list of log forwarders for given domain
LogForwardersShow	Get /domains/{domain}/log-forwarders/{logForwarderId}	Show a log forwarder's details based on given id
LogForwardersStore	Post /domains/{domain}/log-forwarders	Create new log forwarder
LogForwardersUpdate	Put /domains/{domain}/log-forwarders/{logForwarderId}	Update a log forwarder
LogForwardersUpdateStatus	Patch /domains/{domain}/log-forwarders/{logForwarderId}/status	Update a log forwarder's status

LogForwardersDestroy

MessageResponse LogForwardersDestroy(ctx, domain, logForwarderId).Execute()

delete a log forwarder

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arvancloud/cdn-go"
)

func main() {
    domain := "example.com" // string | Domain name
    logForwarderId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Log Forwarder Id

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogForwardersApi.LogForwardersDestroy(context.Background(), domain, logForwarderId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogForwardersApi.LogForwardersDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LogForwardersDestroy`: MessageResponse
    fmt.Fprintf(os.Stdout, "Response from `LogForwardersApi.LogForwardersDestroy`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string	Domain name
logForwarderId	string	Log Forwarder Id

Other Parameters

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

Name	Type	Description	Notes

Return type

MessageResponse

Authorization

ApiKey, UserToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

LogForwardersIndex

LogForwardersIndex200Response LogForwardersIndex(ctx, domain).PerPage(perPage).Page(page).Execute()

Show list of log forwarders for given domain

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arvancloud/cdn-go"
)

func main() {
    domain := "example.com" // string | Domain name
    perPage := int32(56) // int32 | Set how many items returned per page (optional)
    page := int32(56) // int32 | Set the desired page number (optional) (default to 1)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogForwardersApi.LogForwardersIndex(context.Background(), domain).PerPage(perPage).Page(page).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogForwardersApi.LogForwardersIndex``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LogForwardersIndex`: LogForwardersIndex200Response
    fmt.Fprintf(os.Stdout, "Response from `LogForwardersApi.LogForwardersIndex`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string	Domain name

Other Parameters

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

Name	Type	Description	Notes

Return type

LogForwardersIndex200Response

Authorization

ApiKey, UserToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

LogForwardersShow

LogForwarderResponse LogForwardersShow(ctx, domain, logForwarderId).Execute()

Show a log forwarder's details based on given id

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arvancloud/cdn-go"
)

func main() {
    domain := "example.com" // string | Domain name
    logForwarderId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Log Forwarder Id

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogForwardersApi.LogForwardersShow(context.Background(), domain, logForwarderId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogForwardersApi.LogForwardersShow``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LogForwardersShow`: LogForwarderResponse
    fmt.Fprintf(os.Stdout, "Response from `LogForwardersApi.LogForwardersShow`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string	Domain name
logForwarderId	string	Log Forwarder Id

Other Parameters

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

Name	Type	Description	Notes

Return type

LogForwarderResponse

Authorization

ApiKey, UserToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

LogForwardersStore

LogForwarderResponse LogForwardersStore(ctx, domain).LogForwarder(logForwarder).Execute()

Create new log forwarder

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arvancloud/cdn-go"
)

func main() {
    domain := "example.com" // string | Domain name
    logForwarder := *openapiclient.NewLogForwarder("Name_example", "Description_example", "Type_example", "ConnectionType_example", openapiclient.LogForwarderDataFormat{LogForwarderAccessLogType: openapiclient.NewLogForwarderAccessLogType()}, openapiclient.LogForwarderSetting{LogForwarderDatadogConnectionType: openapiclient.NewLogForwarderDatadogConnectionType()}, false) // LogForwarder |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogForwardersApi.LogForwardersStore(context.Background(), domain).LogForwarder(logForwarder).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogForwardersApi.LogForwardersStore``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LogForwardersStore`: LogForwarderResponse
    fmt.Fprintf(os.Stdout, "Response from `LogForwardersApi.LogForwardersStore`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string	Domain name

Other Parameters

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

Name	Type	Description	Notes

logForwarder | LogForwarder | |

Return type

LogForwarderResponse

Authorization

ApiKey, UserToken

HTTP request headers

Content-Type: application/json
Accept: application/json

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

LogForwardersUpdate

LogForwarderResponse LogForwardersUpdate(ctx, domain, logForwarderId).LogForwarder(logForwarder).Execute()

Update a log forwarder

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arvancloud/cdn-go"
)

func main() {
    domain := "example.com" // string | Domain name
    logForwarderId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Log Forwarder Id
    logForwarder := *openapiclient.NewLogForwarder("Name_example", "Description_example", "Type_example", "ConnectionType_example", openapiclient.LogForwarderDataFormat{LogForwarderAccessLogType: openapiclient.NewLogForwarderAccessLogType()}, openapiclient.LogForwarderSetting{LogForwarderDatadogConnectionType: openapiclient.NewLogForwarderDatadogConnectionType()}, false) // LogForwarder |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogForwardersApi.LogForwardersUpdate(context.Background(), domain, logForwarderId).LogForwarder(logForwarder).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogForwardersApi.LogForwardersUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LogForwardersUpdate`: LogForwarderResponse
    fmt.Fprintf(os.Stdout, "Response from `LogForwardersApi.LogForwardersUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string	Domain name
logForwarderId	string	Log Forwarder Id

Other Parameters

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

Name	Type	Description	Notes

logForwarder | LogForwarder | |

Return type

LogForwarderResponse

Authorization

ApiKey, UserToken

HTTP request headers

Content-Type: application/json
Accept: application/json

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

LogForwardersUpdateStatus

LogForwarderResponse LogForwardersUpdateStatus(ctx, domain, logForwarderId).UpdateBooleanStatus(updateBooleanStatus).Execute()

Update a log forwarder's status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arvancloud/cdn-go"
)

func main() {
    domain := "example.com" // string | Domain name
    logForwarderId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Log Forwarder Id
    updateBooleanStatus := *openapiclient.NewUpdateBooleanStatus() // UpdateBooleanStatus |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogForwardersApi.LogForwardersUpdateStatus(context.Background(), domain, logForwarderId).UpdateBooleanStatus(updateBooleanStatus).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogForwardersApi.LogForwardersUpdateStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LogForwardersUpdateStatus`: LogForwarderResponse
    fmt.Fprintf(os.Stdout, "Response from `LogForwardersApi.LogForwardersUpdateStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
domain	string	Domain name
logForwarderId	string	Log Forwarder Id

Other Parameters

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

Name	Type	Description	Notes

updateBooleanStatus | UpdateBooleanStatus | |

Return type

LogForwarderResponse

Authorization

ApiKey, UserToken

HTTP request headers

Content-Type: application/json
Accept: application/json

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

FilesExpand file tree

LogForwardersApi.md

Latest commit

History

LogForwardersApi.md

File metadata and controls

\LogForwardersApi

LogForwardersDestroy

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

LogForwardersIndex

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

LogForwardersShow

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

LogForwardersStore

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

LogForwardersUpdate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

LogForwardersUpdateStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers