Skip to content

Latest commit

 

History

History
370 lines (243 loc) · 12.4 KB

TransportLayerProxyApi.md

File metadata and controls

370 lines (243 loc) · 12.4 KB

\TransportLayerProxyApi

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

Method HTTP request Description
TransportLayerProxiesDestroy Delete /domains/{domain}/transport-layer-proxies/{transportLayerProxyId} delete a transport layer proxy
TransportLayerProxiesIndex Get /domains/{domain}/transport-layer-proxies Show list of transport layer proxies for given domain
TransportLayerProxiesShow Get /domains/{domain}/transport-layer-proxies/{transportLayerProxyId} Show a transport layer proxy's details based on given id
TransportLayerProxiesStore Post /domains/{domain}/transport-layer-proxies Create new transport layer proxy
TransportLayerProxiesUpdate Put /domains/{domain}/transport-layer-proxies/{transportLayerProxyId} Update a transport layer proxy

TransportLayerProxiesDestroy

MessageResponse TransportLayerProxiesDestroy(ctx, domain, transportLayerProxyId).Execute()

delete a transport layer proxy

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arash-r1c/cdn-go-sdk"
)

func main() {
    domain := "example.com" // string | Domain name
    transportLayerProxyId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Transport layer proxy id

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiTransportLayerProxiesDestroyRequest 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]

TransportLayerProxiesIndex

TransportLayerProxiesIndex200Response TransportLayerProxiesIndex(ctx, domain).PerPage(perPage).Page(page).Execute()

Show list of transport layer proxies for given domain

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arash-r1c/cdn-go-sdk"
)

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.TransportLayerProxyApi.TransportLayerProxiesIndex(context.Background(), domain).PerPage(perPage).Page(page).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransportLayerProxyApi.TransportLayerProxiesIndex``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TransportLayerProxiesIndex`: TransportLayerProxiesIndex200Response
    fmt.Fprintf(os.Stdout, "Response from `TransportLayerProxyApi.TransportLayerProxiesIndex`: %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 apiTransportLayerProxiesIndexRequest struct via the builder pattern

Name Type Description Notes

perPage | int32 | Set how many items returned per page | page | int32 | Set the desired page number | [default to 1]

Return type

TransportLayerProxiesIndex200Response

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]

TransportLayerProxiesShow

TransportLayerProxyResponse TransportLayerProxiesShow(ctx, domain, transportLayerProxyId).Execute()

Show a transport layer proxy's details based on given id

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arash-r1c/cdn-go-sdk"
)

func main() {
    domain := "example.com" // string | Domain name
    transportLayerProxyId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Transport layer proxy id

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

TransportLayerProxyResponse

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]

TransportLayerProxiesStore

TransportLayerProxyResponse TransportLayerProxiesStore(ctx, domain).TransportLayerProxyStore(transportLayerProxyStore).Execute()

Create new transport layer proxy

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arash-r1c/cdn-go-sdk"
)

func main() {
    domain := "example.com" // string | Domain name
    transportLayerProxyStore := *openapiclient.NewTransportLayerProxyStore("AppName_example", "sub.example.com", int32(123), "ProxyProtocol_example", "BalanceAlgorithm_example", "FirewallDefaultAction_example") // TransportLayerProxyStore |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TransportLayerProxyApi.TransportLayerProxiesStore(context.Background(), domain).TransportLayerProxyStore(transportLayerProxyStore).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransportLayerProxyApi.TransportLayerProxiesStore``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TransportLayerProxiesStore`: TransportLayerProxyResponse
    fmt.Fprintf(os.Stdout, "Response from `TransportLayerProxyApi.TransportLayerProxiesStore`: %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 apiTransportLayerProxiesStoreRequest struct via the builder pattern

Name Type Description Notes

transportLayerProxyStore | TransportLayerProxyStore | |

Return type

TransportLayerProxyResponse

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]

TransportLayerProxiesUpdate

TransportLayerProxyResponse TransportLayerProxiesUpdate(ctx, domain, transportLayerProxyId).TransportLayerProxyUpdate(transportLayerProxyUpdate).Execute()

Update a transport layer proxy

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/arash-r1c/cdn-go-sdk"
)

func main() {
    domain := "example.com" // string | Domain name
    transportLayerProxyId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Transport layer proxy id
    transportLayerProxyUpdate := *openapiclient.NewTransportLayerProxyUpdate("AppName_example", "ProxyProtocol_example", "BalanceAlgorithm_example") // TransportLayerProxyUpdate |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

transportLayerProxyUpdate | TransportLayerProxyUpdate | |

Return type

TransportLayerProxyResponse

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]