Developer-friendly & type-safe Go SDK specifically catered to leverage openapi API.
To add the SDK as a dependency to your project:
go get github.com/censys/censys-sdk-gopackage main
import (
"context"
censyssdkgo "github.com/censys/censys-sdk-go"
"github.com/censys/censys-sdk-go/models/components"
"github.com/censys/censys-sdk-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := censyssdkgo.New(
censyssdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
)
res, err := s.GlobalData.Search(ctx, operations.V3GlobaldataSearchQueryRequest{
OrganizationID: censyssdkgo.String("<id>"),
SearchQueryInputBody: components.SearchQueryInputBody{
Query: "<value>",
},
})
if err != nil {
log.Fatal(err)
}
if res.ResponseEnvelopeSearchQueryResponse != nil {
// handle response
}
}Available methods
- List - List Collections
- Create - Create a Collection
- Delete - Delete a Collection
- Get - Get a Collection
- Update - Update a Collection
- ListEvents - List a Collection's events
- Aggregate - Search / Aggregate
- Search - Search / Query
- GetCertificates - Asset / Certificate Bulk
- GetCertificate - Asset / Certificate
- GetHosts - Asset / Host Bulk
- GetHost - Asset / Host
- GetHostTimeline - Asset / Host Timeline
- GetWebProperties - Asset / WebProperty Bulk
- GetWebProperty - Asset / WebProperty
- Aggregate - Search / Aggregate
- Search - Search / Query
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set organization_id to "<id>" at SDK initialization and then you do not have to pass the same value on calls to operations like List. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
| Name | Type | Description |
|---|---|---|
| OrganizationID | string | The OrganizationID parameter. |
package main
import (
"context"
censyssdkgo "github.com/censys/censys-sdk-go"
"github.com/censys/censys-sdk-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := censyssdkgo.New(
censyssdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
)
res, err := s.Collections.List(ctx, operations.V3CollectionsCrudListRequest{
OrganizationID: censyssdkgo.String("<id>"),
})
if err != nil {
log.Fatal(err)
}
if res.ResponseEnvelopeListCollectionsResponseV1 != nil {
// handle response
}
}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"
censyssdkgo "github.com/censys/censys-sdk-go"
"github.com/censys/censys-sdk-go/models/operations"
"github.com/censys/censys-sdk-go/retry"
"log"
"models/operations"
)
func main() {
ctx := context.Background()
s := censyssdkgo.New(
censyssdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
)
res, err := s.Collections.List(ctx, operations.V3CollectionsCrudListRequest{
OrganizationID: censyssdkgo.String("<id>"),
}, 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.ResponseEnvelopeListCollectionsResponseV1 != 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"
censyssdkgo "github.com/censys/censys-sdk-go"
"github.com/censys/censys-sdk-go/models/operations"
"github.com/censys/censys-sdk-go/retry"
"log"
)
func main() {
ctx := context.Background()
s := censyssdkgo.New(
censyssdkgo.WithRetryConfig(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}),
censyssdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
)
res, err := s.Collections.List(ctx, operations.V3CollectionsCrudListRequest{
OrganizationID: censyssdkgo.String("<id>"),
})
if err != nil {
log.Fatal(err)
}
if res.ResponseEnvelopeListCollectionsResponseV1 != nil {
// handle response
}
}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 List function may return the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| sdkerrors.ErrorModel | 401, 403 | application/problem+json |
| sdkerrors.SDKError | 4XX, 5XX | */* |
package main
import (
"context"
"errors"
censyssdkgo "github.com/censys/censys-sdk-go"
"github.com/censys/censys-sdk-go/models/operations"
"github.com/censys/censys-sdk-go/models/sdkerrors"
"log"
)
func main() {
ctx := context.Background()
s := censyssdkgo.New(
censyssdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
)
res, err := s.Collections.List(ctx, operations.V3CollectionsCrudListRequest{
OrganizationID: censyssdkgo.String("<id>"),
})
if err != nil {
var e *sdkerrors.ErrorModel
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())
}
}
}The default server can be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:
package main
import (
"context"
censyssdkgo "github.com/censys/censys-sdk-go"
"github.com/censys/censys-sdk-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := censyssdkgo.New(
censyssdkgo.WithServerURL("https://api.platform.censys.io"),
censyssdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
)
res, err := s.Collections.List(ctx, operations.V3CollectionsCrudListRequest{
OrganizationID: censyssdkgo.String("<id>"),
})
if err != nil {
log.Fatal(err)
}
if res.ResponseEnvelopeListCollectionsResponseV1 != 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 scheme globally:
| Name | Type | Scheme |
|---|---|---|
PersonalAccessToken |
http | HTTP Bearer |
You can configure it using the WithSecurity option when initializing the SDK client instance. For example:
package main
import (
"context"
censyssdkgo "github.com/censys/censys-sdk-go"
"github.com/censys/censys-sdk-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := censyssdkgo.New(
censyssdkgo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
)
res, err := s.Collections.List(ctx, operations.V3CollectionsCrudListRequest{
OrganizationID: censyssdkgo.String("<id>"),
})
if err != nil {
log.Fatal(err)
}
if res.ResponseEnvelopeListCollectionsResponseV1 != nil {
// handle response
}
}This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.