\CertificatesAPI

All URIs are relative to http://localhost/api

Method	HTTP request	Description
CreateCertificate	Post /nginx/certificates	Create a Certificate
DeleteCertificate	Delete /nginx/certificates/{certID}	Delete a Certificate
DownloadCertificate	Get /nginx/certificates/{certID}/download	Downloads a Certificate
GetCertificate	Get /nginx/certificates/{certID}	Get a Certificate
GetCertificates	Get /nginx/certificates	Get all certificates
GetDNSProviders	Get /nginx/certificates/dns-providers	Get DNS Providers for Certificates
RenewCertificate	Post /nginx/certificates/{certID}/renew	Renews a Certificate
TestHttpReach	Post /nginx/certificates/test-http	Test HTTP Reachability
UploadCertificate	Post /nginx/certificates/{certID}/upload	Uploads a custom Certificate
ValidateCertificates	Post /nginx/certificates/validate	Validates given Custom Certificates

CreateCertificate

GetCertificates200ResponseInner CreateCertificate(ctx).CreateCertificateRequest(createCertificateRequest).Execute()

Create a Certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	createCertificateRequest := *openapiclient.NewCreateCertificateRequest("letsencrypt") // CreateCertificateRequest | Certificate Payload

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
createCertificateRequest	CreateCertificateRequest	Certificate Payload

Return type

GetCertificates200ResponseInner

Authorization

bearerAuth

HTTP request headers

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

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

DeleteCertificate

bool DeleteCertificate(ctx, certID).Execute()

Delete a Certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	certID := int64(2) // int64 | Certificate ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
certID	int64	Certificate ID

Other Parameters

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

Name	Type	Description	Notes

Return type

bool

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

DownloadCertificate

*os.File DownloadCertificate(ctx, certID).Execute()

Downloads a Certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	certID := int64(1) // int64 | Certificate ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
certID	int64	Certificate ID

Other Parameters

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

Name	Type	Description	Notes

Return type

*os.File

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/zip

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

GetCertificate

GetCertificates200ResponseInner GetCertificate(ctx, certID).Execute()

Get a Certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	certID := int64(1) // int64 | Certificate ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
certID	int64	Certificate ID

Other Parameters

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

Name	Type	Description	Notes

Return type

GetCertificates200ResponseInner

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetCertificates

[]GetCertificates200ResponseInner GetCertificates(ctx).Expand(expand).Execute()

Get all certificates

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	expand := "expand_example" // string | Expansions (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CertificatesAPI.GetCertificates(context.Background()).Expand(expand).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CertificatesAPI.GetCertificates``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetCertificates`: []GetCertificates200ResponseInner
	fmt.Fprintf(os.Stdout, "Response from `CertificatesAPI.GetCertificates`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
expand	string	Expansions

Return type

[]GetCertificates200ResponseInner

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetDNSProviders

[]GetDNSProviders200ResponseInner GetDNSProviders(ctx).Execute()

Get DNS Providers for Certificates

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]GetDNSProviders200ResponseInner

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

RenewCertificate

GetCertificates200ResponseInner RenewCertificate(ctx, certID).Execute()

Renews a Certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	certID := int64(1) // int64 | Certificate ID

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
certID	int64	Certificate ID

Other Parameters

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

Name	Type	Description	Notes

Return type

GetCertificates200ResponseInner

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

TestHttpReach

TestHttpReach(ctx).TestHttpReachRequest(testHttpReachRequest).Execute()

Test HTTP Reachability

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	testHttpReachRequest := *openapiclient.NewTestHttpReachRequest([]string{"Domains_example"}) // TestHttpReachRequest | Test Payload

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
testHttpReachRequest	TestHttpReachRequest	Test Payload

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

UploadCertificate

UploadCertificate200Response UploadCertificate(ctx, certID).Certificate(certificate).CertificateKey(certificateKey).IntermediateCertificate(intermediateCertificate).Execute()

Uploads a custom Certificate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	certID := int64(1) // int64 | Certificate ID
	certificate := "certificate_example" // string | 
	certificateKey := "certificateKey_example" // string | 
	intermediateCertificate := "intermediateCertificate_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CertificatesAPI.UploadCertificate(context.Background(), certID).Certificate(certificate).CertificateKey(certificateKey).IntermediateCertificate(intermediateCertificate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CertificatesAPI.UploadCertificate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UploadCertificate`: UploadCertificate200Response
	fmt.Fprintf(os.Stdout, "Response from `CertificatesAPI.UploadCertificate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
certID	int64	Certificate ID

Other Parameters

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

Name	Type	Description	Notes

Return type

UploadCertificate200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

ValidateCertificates

ValidateCertificates200Response ValidateCertificates(ctx).Certificate(certificate).CertificateKey(certificateKey).IntermediateCertificate(intermediateCertificate).Execute()

Validates given Custom Certificates

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sander0542/nginxproxymanager-go"
)

func main() {
	certificate := "certificate_example" // string | 
	certificateKey := "certificateKey_example" // string | 
	intermediateCertificate := "intermediateCertificate_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CertificatesAPI.ValidateCertificates(context.Background()).Certificate(certificate).CertificateKey(certificateKey).IntermediateCertificate(intermediateCertificate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CertificatesAPI.ValidateCertificates``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ValidateCertificates`: ValidateCertificates200Response
	fmt.Fprintf(os.Stdout, "Response from `CertificatesAPI.ValidateCertificates`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
certificate	string
certificateKey	string
intermediateCertificate	string

Return type

ValidateCertificates200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

FilesExpand file tree

CertificatesAPI.md

Latest commit

History

CertificatesAPI.md

File metadata and controls

\CertificatesAPI

CreateCertificate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteCertificate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadCertificate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetCertificate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetCertificates

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetDNSProviders

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RenewCertificate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestHttpReach

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UploadCertificate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ValidateCertificates

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers