README.md

Miscellaneous

(Miscellaneous)

Available Operations

• GetDNSID - Get DNS ID
• HealthCheck - Health check

GetDNSID

Returns the partially random string used when generating host names for the authenticated account.

Example Usage

package main

import(
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/shared"
	northflankgo "github.com/speakeasy-sdks/northflank-go/v3"
	"context"
	"log"
)

func main() {
    s := northflankgo.New(
        northflankgo.WithSecurity(shared.Security{
            BasicAuth: &shared.SchemeBasicAuth{
                Password: "<YOUR_PASSWORD_HERE>",
                Username: "<YOUR_USERNAME_HERE>",
            },
        }),
    )

    ctx := context.Background()
    res, err := s.Miscellaneous.GetDNSID(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.DNSIDResult != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.

Response

*operations.GetDNSIDResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

HealthCheck

Returns api service status

Example Usage

package main

import(
	"github.com/speakeasy-sdks/northflank-go/v3/pkg/models/shared"
	northflankgo "github.com/speakeasy-sdks/northflank-go/v3"
	"context"
	"log"
)

func main() {
    s := northflankgo.New(
        northflankgo.WithSecurity(shared.Security{
            BasicAuth: &shared.SchemeBasicAuth{
                Password: "<YOUR_PASSWORD_HERE>",
                Username: "<YOUR_USERNAME_HERE>",
            },
        }),
    )

    ctx := context.Background()
    res, err := s.Miscellaneous.HealthCheck(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.

Response

*operations.GetHealthCheckResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/