Skip to content

Latest commit

 

History

History
351 lines (227 loc) · 10.7 KB

AutoCertificateApi.md

File metadata and controls

351 lines (227 loc) · 10.7 KB

\AutoCertificateApi

All URIs are relative to https://certificate-manager.de-fra.ionos.com

Method HTTP request Description
AutoCertificatesDelete Delete /auto-certificates/{autoCertificateId} Delete AutoCertificate
AutoCertificatesFindById Get /auto-certificates/{autoCertificateId} Retrieve AutoCertificate
AutoCertificatesGet Get /auto-certificates Retrieve all AutoCertificate
AutoCertificatesPatch Patch /auto-certificates/{autoCertificateId} Updates AutoCertificate
AutoCertificatesPost Post /auto-certificates Create AutoCertificate

AutoCertificatesDelete

var result  = AutoCertificatesDelete(ctx, autoCertificateId)
                      .Execute()

Delete AutoCertificate

Example

package main

import (
    "context"
    "fmt"
    "os"

    cert "github.com/ionos-cloud/sdk-go-bundle/products/cert"
    "github.com/ionos-cloud/sdk-go-bundle/shared"
)

func main() {
    autoCertificateId := "f88467f8-a2d6-5871-83b9-e10f23d0a48a" // string | The ID (UUID) of the AutoCertificate.

    configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := cert.NewAPIClient(configuration)
    resp, err := apiClient.AutoCertificateApi.AutoCertificatesDelete(context.Background(), autoCertificateId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AutoCertificateApi.AutoCertificatesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
autoCertificateId string The ID (UUID) of the AutoCertificate.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

HTTP request headers

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

AutoCertificatesFindById

var result AutoCertificateRead = AutoCertificatesFindById(ctx, autoCertificateId)
                      .Execute()

Retrieve AutoCertificate

Example

package main

import (
    "context"
    "fmt"
    "os"

    cert "github.com/ionos-cloud/sdk-go-bundle/products/cert"
    "github.com/ionos-cloud/sdk-go-bundle/shared"
)

func main() {
    autoCertificateId := "f88467f8-a2d6-5871-83b9-e10f23d0a48a" // string | The ID (UUID) of the AutoCertificate.

    configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := cert.NewAPIClient(configuration)
    resource, resp, err := apiClient.AutoCertificateApi.AutoCertificatesFindById(context.Background(), autoCertificateId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AutoCertificateApi.AutoCertificatesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `AutoCertificatesFindById`: AutoCertificateRead
    fmt.Fprintf(os.Stdout, "Response from `AutoCertificateApi.AutoCertificatesFindById`: %v\n", resource)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
autoCertificateId string The ID (UUID) of the AutoCertificate.

Other Parameters

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

Name Type Description Notes

Return type

AutoCertificateRead

HTTP request headers

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

AutoCertificatesGet

var result AutoCertificateReadList = AutoCertificatesGet(ctx)
                      .Offset(offset)
                      .Limit(limit)
                      .FilterCommonName(filterCommonName)
                      .Execute()

Retrieve all AutoCertificate

Example

package main

import (
    "context"
    "fmt"
    "os"

    cert "github.com/ionos-cloud/sdk-go-bundle/products/cert"
    "github.com/ionos-cloud/sdk-go-bundle/shared"
)

func main() {
    offset := int32(0) // int32 | The first element (of the total list of elements) to include in the response. Use together with limit for pagination. (optional) (default to 0)
    limit := int32(100) // int32 | The maximum number of elements to return. Use together with offset for pagination. (optional) (default to 100)
    filterCommonName := "www.example.com" // string | Filter by the common name (DNS).  (optional)

    configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := cert.NewAPIClient(configuration)
    resource, resp, err := apiClient.AutoCertificateApi.AutoCertificatesGet(context.Background()).Offset(offset).Limit(limit).FilterCommonName(filterCommonName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AutoCertificateApi.AutoCertificatesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `AutoCertificatesGet`: AutoCertificateReadList
    fmt.Fprintf(os.Stdout, "Response from `AutoCertificateApi.AutoCertificatesGet`: %v\n", resource)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
offset int32 The first element (of the total list of elements) to include in the response. Use together with limit for pagination. [default to 0]
limit int32 The maximum number of elements to return. Use together with offset for pagination. [default to 100]
filterCommonName string Filter by the common name (DNS).

Return type

AutoCertificateReadList

HTTP request headers

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

AutoCertificatesPatch

var result AutoCertificateRead = AutoCertificatesPatch(ctx, autoCertificateId)
                      .AutoCertificatePatch(autoCertificatePatch)
                      .Execute()

Updates AutoCertificate

Example

package main

import (
    "context"
    "fmt"
    "os"

    cert "github.com/ionos-cloud/sdk-go-bundle/products/cert"
    "github.com/ionos-cloud/sdk-go-bundle/shared"
)

func main() {
    autoCertificateId := "f88467f8-a2d6-5871-83b9-e10f23d0a48a" // string | The ID (UUID) of the AutoCertificate.
    autoCertificatePatch := *openapiclient.NewAutoCertificatePatch(*openapiclient.NewPatchName("My name")) // AutoCertificatePatch | patch AutoCertificate

    configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := cert.NewAPIClient(configuration)
    resource, resp, err := apiClient.AutoCertificateApi.AutoCertificatesPatch(context.Background(), autoCertificateId).AutoCertificatePatch(autoCertificatePatch).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AutoCertificateApi.AutoCertificatesPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `AutoCertificatesPatch`: AutoCertificateRead
    fmt.Fprintf(os.Stdout, "Response from `AutoCertificateApi.AutoCertificatesPatch`: %v\n", resource)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
autoCertificateId string The ID (UUID) of the AutoCertificate.

Other Parameters

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

Name Type Description Notes
autoCertificatePatch AutoCertificatePatch patch AutoCertificate

Return type

AutoCertificateRead

HTTP request headers

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

AutoCertificatesPost

var result AutoCertificateRead = AutoCertificatesPost(ctx)
                      .AutoCertificateCreate(autoCertificateCreate)
                      .Execute()

Create AutoCertificate

Example

package main

import (
    "context"
    "fmt"
    "os"

    cert "github.com/ionos-cloud/sdk-go-bundle/products/cert"
    "github.com/ionos-cloud/sdk-go-bundle/shared"
)

func main() {
    autoCertificateCreate := *openapiclient.NewAutoCertificateCreate(*openapiclient.NewAutoCertificate("b471cd03-ef51-52c5-91a5-49195b0a04d4", "www.example.com", "rsa4096")) // AutoCertificateCreate | AutoCertificate to create.

    configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := cert.NewAPIClient(configuration)
    resource, resp, err := apiClient.AutoCertificateApi.AutoCertificatesPost(context.Background()).AutoCertificateCreate(autoCertificateCreate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AutoCertificateApi.AutoCertificatesPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `AutoCertificatesPost`: AutoCertificateRead
    fmt.Fprintf(os.Stdout, "Response from `AutoCertificateApi.AutoCertificatesPost`: %v\n", resource)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
autoCertificateCreate AutoCertificateCreate AutoCertificate to create.

Return type

AutoCertificateRead

HTTP request headers

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