This is a prototype and should not be used. See CONTRIBUTING.md for information on how this SDK is generated.
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.
By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.
For example, the ListControlPlanes function may return the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| sdkerrors.BadRequestError | 400 | application/problem+json |
| sdkerrors.UnauthorizedError | 401 | application/problem+json |
| sdkerrors.ForbiddenError | 403 | application/problem+json |
| sdkerrors.ServiceUnavailable | 503 | application/problem+json |
| sdkerrors.SDKError | 4XX, 5XX | */* |
package main
import (
"context"
"errors"
sdkkonnectgo "github.com/Kong/sdk-konnect-go"
"github.com/Kong/sdk-konnect-go/models/components"
"github.com/Kong/sdk-konnect-go/models/operations"
"github.com/Kong/sdk-konnect-go/models/sdkerrors"
"log"
)
func main() {
s := sdkkonnectgo.New(
sdkkonnectgo.WithSecurity(components.Security{
PersonalAccessToken: sdkkonnectgo.String("<YOUR_BEARER_TOKEN_HERE>"),
}),
)
ctx := context.Background()
res, err := s.ControlPlanes.ListControlPlanes(ctx, operations.ListControlPlanesRequest{
PageSize: sdkkonnectgo.Int64(10),
PageNumber: sdkkonnectgo.Int64(1),
Filter: &components.ControlPlaneFilterParameters{
CloudGateway: sdkkonnectgo.Bool(true),
},
Labels: sdkkonnectgo.String("key:value,existCheck"),
Sort: sdkkonnectgo.String("name,created_at desc"),
})
if err != nil {
var e *sdkerrors.BadRequestError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.UnauthorizedError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.ForbiddenError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.ServiceUnavailable
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.SDKError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}You can override the default server globally using the WithServerIndex(serverIndex int) option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server |
|---|---|
| 0 | https://global.api.konghq.com |
| 1 | https://us.api.konghq.com |
| 2 | https://eu.api.konghq.com |
| 3 | https://au.api.konghq.com |
package main
import (
"context"
sdkkonnectgo "github.com/Kong/sdk-konnect-go"
"github.com/Kong/sdk-konnect-go/models/components"
"github.com/Kong/sdk-konnect-go/models/operations"
"log"
)
func main() {
s := sdkkonnectgo.New(
sdkkonnectgo.WithServerIndex(3),
sdkkonnectgo.WithSecurity(components.Security{
PersonalAccessToken: sdkkonnectgo.String("<YOUR_BEARER_TOKEN_HERE>"),
}),
)
ctx := context.Background()
res, err := s.ControlPlanes.ListControlPlanes(ctx, operations.ListControlPlanesRequest{
PageSize: sdkkonnectgo.Int64(10),
PageNumber: sdkkonnectgo.Int64(1),
Filter: &components.ControlPlaneFilterParameters{
CloudGateway: sdkkonnectgo.Bool(true),
},
Labels: sdkkonnectgo.String("key:value,existCheck"),
Sort: sdkkonnectgo.String("name,created_at desc"),
})
if err != nil {
log.Fatal(err)
}
if res.ListControlPlanesResponse != nil {
// handle response
}
}The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:
package main
import (
"context"
sdkkonnectgo "github.com/Kong/sdk-konnect-go"
"github.com/Kong/sdk-konnect-go/models/components"
"github.com/Kong/sdk-konnect-go/models/operations"
"log"
)
func main() {
s := sdkkonnectgo.New(
sdkkonnectgo.WithServerURL("https://global.api.konghq.com"),
sdkkonnectgo.WithSecurity(components.Security{
PersonalAccessToken: sdkkonnectgo.String("<YOUR_BEARER_TOKEN_HERE>"),
}),
)
ctx := context.Background()
res, err := s.ControlPlanes.ListControlPlanes(ctx, operations.ListControlPlanesRequest{
PageSize: sdkkonnectgo.Int64(10),
PageNumber: sdkkonnectgo.Int64(1),
Filter: &components.ControlPlaneFilterParameters{
CloudGateway: sdkkonnectgo.Bool(true),
},
Labels: sdkkonnectgo.String("key:value,existCheck"),
Sort: sdkkonnectgo.String("name,created_at desc"),
})
if err != nil {
log.Fatal(err)
}
if res.ListControlPlanesResponse != nil {
// handle response
}
}The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
package main
import (
"context"
sdkkonnectgo "github.com/Kong/sdk-konnect-go"
"github.com/Kong/sdk-konnect-go/models/components"
"github.com/Kong/sdk-konnect-go/models/operations"
"log"
)
func main() {
s := sdkkonnectgo.New(
sdkkonnectgo.WithSecurity(components.Security{
PersonalAccessToken: sdkkonnectgo.String("<YOUR_BEARER_TOKEN_HERE>"),
}),
)
ctx := context.Background()
res, err := s.Authentication.AuthenticateSso(ctx, "<value>", nil, operations.WithServerURL("https://global.api.konghq.com/"))
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
import (
"net/http"
"time"
"github.com/myorg/your-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sdk.New(sdk.WithClient(httpClient))
)This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
|---|---|---|
PersonalAccessToken |
http | HTTP Bearer |
SystemAccountAccessToken |
http | HTTP Bearer |
KonnectAccessToken |
http | HTTP Bearer |
You can set the security parameters through the WithSecurity option when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
package main
import (
"context"
sdkkonnectgo "github.com/Kong/sdk-konnect-go"
"github.com/Kong/sdk-konnect-go/models/components"
"github.com/Kong/sdk-konnect-go/models/operations"
"log"
)
func main() {
s := sdkkonnectgo.New(
sdkkonnectgo.WithSecurity(components.Security{
PersonalAccessToken: sdkkonnectgo.String("<YOUR_BEARER_TOKEN_HERE>"),
}),
)
ctx := context.Background()
res, err := s.ControlPlanes.ListControlPlanes(ctx, operations.ListControlPlanesRequest{
PageSize: sdkkonnectgo.Int64(10),
PageNumber: sdkkonnectgo.Int64(1),
Filter: &components.ControlPlaneFilterParameters{
CloudGateway: sdkkonnectgo.Bool(true),
},
Labels: sdkkonnectgo.String("key:value,existCheck"),
Sort: sdkkonnectgo.String("name,created_at desc"),
})
if err != nil {
log.Fatal(err)
}
if res.ListControlPlanesResponse != nil {
// handle response
}
}Konnect API - Go SDK: The Konnect platform API
For more information about the API: Documentation for Kong Gateway and its APIs
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:
package main
import (
"context"
sdkkonnectgo "github.com/Kong/sdk-konnect-go"
"github.com/Kong/sdk-konnect-go/models/components"
"github.com/Kong/sdk-konnect-go/models/operations"
"github.com/Kong/sdk-konnect-go/retry"
"log"
"models/operations"
)
func main() {
s := sdkkonnectgo.New(
sdkkonnectgo.WithSecurity(components.Security{
PersonalAccessToken: sdkkonnectgo.String("<YOUR_BEARER_TOKEN_HERE>"),
}),
)
ctx := context.Background()
res, err := s.ControlPlanes.ListControlPlanes(ctx, operations.ListControlPlanesRequest{
PageSize: sdkkonnectgo.Int64(10),
PageNumber: sdkkonnectgo.Int64(1),
Filter: &components.ControlPlaneFilterParameters{
CloudGateway: sdkkonnectgo.Bool(true),
},
Labels: sdkkonnectgo.String("key:value,existCheck"),
Sort: sdkkonnectgo.String("name,created_at desc"),
}, operations.WithRetries(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}))
if err != nil {
log.Fatal(err)
}
if res.ListControlPlanesResponse != nil {
// handle response
}
}If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:
package main
import (
"context"
sdkkonnectgo "github.com/Kong/sdk-konnect-go"
"github.com/Kong/sdk-konnect-go/models/components"
"github.com/Kong/sdk-konnect-go/models/operations"
"github.com/Kong/sdk-konnect-go/retry"
"log"
)
func main() {
s := sdkkonnectgo.New(
sdkkonnectgo.WithRetryConfig(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}),
sdkkonnectgo.WithSecurity(components.Security{
PersonalAccessToken: sdkkonnectgo.String("<YOUR_BEARER_TOKEN_HERE>"),
}),
)
ctx := context.Background()
res, err := s.ControlPlanes.ListControlPlanes(ctx, operations.ListControlPlanesRequest{
PageSize: sdkkonnectgo.Int64(10),
PageNumber: sdkkonnectgo.Int64(1),
Filter: &components.ControlPlaneFilterParameters{
CloudGateway: sdkkonnectgo.Bool(true),
},
Labels: sdkkonnectgo.String("key:value,existCheck"),
Sort: sdkkonnectgo.String("name,created_at desc"),
})
if err != nil {
log.Fatal(err)
}
if res.ListControlPlanesResponse != nil {
// handle response
}
}d