Skip to content

Latest commit

 

History

History
213 lines (133 loc) · 5.93 KB

OutgoingTLSPolicyMapOverridesApi.md

File metadata and controls

213 lines (133 loc) · 5.93 KB
Raw

\OutgoingTLSPolicyMapOverridesApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateTLSPolicyMap Post /api/v1/add/tls-policy-map Create TLS Policy Map
DeleteTLSPolicyMap Post /api/v1/delete/tls-policy-map Delete TLS Policy Map
GetTLSPolicyMap Get /api/v1/get/tls-policy-map/{id} Get TLS Policy Map

CreateTLSPolicyMap

CreateAlias200Response CreateTLSPolicyMap(ctx).CreateTLSPolicyMapRequest(createTLSPolicyMapRequest).Execute()

Create TLS Policy Map

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    createTLSPolicyMapRequest := *openapiclient.NewCreateTLSPolicyMapRequest() // CreateTLSPolicyMapRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createTLSPolicyMapRequest CreateTLSPolicyMapRequest

Return type

CreateAlias200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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

DeleteTLSPolicyMap

CreateAlias200Response DeleteTLSPolicyMap(ctx).DeleteTLSPolicyMapRequest(deleteTLSPolicyMapRequest).Execute()

Delete TLS Policy Map

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    deleteTLSPolicyMapRequest := *openapiclient.NewDeleteTLSPolicyMapRequest() // DeleteTLSPolicyMapRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deleteTLSPolicyMapRequest DeleteTLSPolicyMapRequest

Return type

CreateAlias200Response

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetTLSPolicyMap

GetTLSPolicyMap(ctx, id).XAPIKey(xAPIKey).Execute()

Get TLS Policy Map

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/shoopea/mailcow-go"
)

func main() {
    id := "all" // string | id of entry you want to get
    xAPIKey := "api-key-string" // string | e.g. api-key-string (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.OutgoingTLSPolicyMapOverridesApi.GetTLSPolicyMap(context.Background(), id).XAPIKey(xAPIKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutgoingTLSPolicyMapOverridesApi.GetTLSPolicyMap``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string id of entry you want to get

Other Parameters

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

Name Type Description Notes

xAPIKey | string | e.g. api-key-string |

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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