ResourcesApi.md

\ResourcesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
CreateResources	Post /api/v1/add/resource	Create Resources
DeleteResources	Post /api/v1/delete/resource	Delete Resources
GetResources	Get /api/v1/get/resource/all	Get Resources

CreateResources

CreateAlias200Response CreateResources(ctx).CreateResourcesRequest(createResourcesRequest).Execute()

Create Resources

Example

package main

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

func main() {
    createResourcesRequest := *openapiclient.NewCreateResourcesRequest() // CreateResourcesRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
createResourcesRequest	CreateResourcesRequest

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]

DeleteResources

CreateAlias200Response DeleteResources(ctx).DeleteResourcesRequest(deleteResourcesRequest).Execute()

Delete Resources

Example

package main

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

func main() {
    deleteResourcesRequest := *openapiclient.NewDeleteResourcesRequest() // DeleteResourcesRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
deleteResourcesRequest	DeleteResourcesRequest

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]

GetResources

GetResources(ctx).Execute()

Get Resources

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]