Go API client for ionoscloud

With IONOS Cloud Database as a Service, you have the ability to quickly set up and manage a MongoDB database. You can also delete clusters, manage backups and users via the API.

MongoDB is an open source, cross-platform, document-oriented database program. Classified as a NoSQL database program, it uses JSON-like documents with optional schemas.

The MongoDB API allows you to create additional database clusters or modify existing ones. Both tools, the Data Center Designer (DCD) and the API use the same concepts consistently and are well suited for smooth and intuitive use.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.4.1
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ionoscloud "github.com/ionos-cloud/sdk-go-dbaas-mongo"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ionoscloud.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ionoscloud.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

Documentation for API Endpoints

All URIs are relative to https://api.ionos.com/databases/mongodb

Class	Method	HTTP request	Description
ClustersApi	ClustersDelete	Delete /clusters/{clusterId}	Delete a Cluster
ClustersApi	ClustersFindById	Get /clusters/{clusterId}	Get a cluster by id
ClustersApi	ClustersGet	Get /clusters	Get Clusters
ClustersApi	ClustersPatch	Patch /clusters/{clusterId}	Patch a cluster
ClustersApi	ClustersPost	Post /clusters	Create a Cluster
LogsApi	ClustersLogsGet	Get /clusters/{clusterId}/logs	Get logs of your cluster
MetadataApi	InfosVersionGet	Get /infos/version	Get API Version
MetadataApi	InfosVersionsGet	Get /infos/versions	Get All API Versions
RestoresApi	ClustersRestorePost	Post /clusters/{clusterId}/restore	In-place restore of a cluster
SnapshotsApi	ClustersSnapshotsGet	Get /clusters/{clusterId}/snapshots	Get the snapshots of your cluster
TemplatesApi	TemplatesGet	Get /templates	Get Templates
UsersApi	ClustersUsersDelete	Delete /clusters/{clusterId}/users/{username}	Delete a MongoDB User by ID
UsersApi	ClustersUsersFindById	Get /clusters/{clusterId}/users/{username}	Get a MongoDB User by ID
UsersApi	ClustersUsersGet	Get /clusters/{clusterId}/users	Get all Cluster Users
UsersApi	ClustersUsersPatch	Patch /clusters/{clusterId}/users/{username}	Patch a MongoDB User by ID
UsersApi	ClustersUsersPost	Post /clusters/{clusterId}/users	Create MongoDB User

Documentation For Models

• APIVersion
• BackupProperties
• BiConnectorProperties
• ClusterList
• ClusterListAllOf
• ClusterLogs
• ClusterLogsInstances
• ClusterLogsInstancesMessages
• ClusterProperties
• ClusterResponse
• Connection
• CreateClusterProperties
• CreateClusterRequest
• CreateRestoreRequest
• DayOfTheWeek
• ErrorMessage
• ErrorResponse
• Health
• MaintenanceWindow
• Metadata
• Pagination
• PaginationLinks
• PatchClusterProperties
• PatchClusterRequest
• PatchUserProperties
• PatchUserRequest
• ResourceType
• SnapshotList
• SnapshotListAllOf
• SnapshotProperties
• SnapshotResponse
• State
• StorageType
• TemplateList
• TemplateListAllOf
• TemplateProperties
• TemplateResponse
• User
• UserMetadata
• UserProperties
• UserRoles
• UsersList

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author