Skip to content

IBM/platform-services-go-sdk

This branch is up to date with main.

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Release Go Reference GitHub go.mod Go version License semantic-release CLA assistant

IBM Cloud Platform Services Go SDK Version 0.72.0

Go client library to interact with various IBM Cloud Platform Service APIs.

Table of Contents

Overview

The IBM Cloud Platform Services Go SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name Package name
Activity Tracker atrackerv2
Case Management casemanagementv1
Catalog Management catalogmanagementv1
Context Based Restrictions contextbasedrestrictionsv1
Enterprise Billing Units enterprisebillingunitsv1
Enterprise Management enterprisemanagementv1
Enterprise Usage Reports enterpriseusagereportsv1
Global Catalog globalcatalogv1
Global Search globalsearchv2
Global Tagging globaltaggingv1
IAM Access Groups iamaccessgroupsv2
IAM Identity Service iamidentityv1
IAM Policy Management iampolicymanagementv1
IBM Cloud Shell ibmcloudshellv1
Metrics Router metricsrouterv3
Open Service Broker openservicebrokerv1
Partner Center Sell partnercentersellv1
Partner Management APIs partnermanagementv1
Resource Controller resourcecontrollerv2
Resource Manager resourcemanagerv2
Usage Metering usagemeteringv4
Usage Reports usagereportsv4
User Management usermanagementv1

The following services have been relocated to a different SDK project. Please consult the documentation for each service to determine the new location:

Service Name Package name
Configuration Governance configurationgovernancev1
Posture Management posturemanagementv1

Prerequisites

  • An IBM Cloud account.
  • An IAM API key to allow the SDK to access your account. Create one here.
  • Go version 1.21 or above.

Installation

The current version of this SDK: 0.72.0

Go modules

If your application uses Go modules for dependency management (recommended), just add an import for each service that you will use in your application.
Here is an example:

import (
	"github.com/IBM/platform-services-go-sdk/globalsearchv2"
)

Next, run go build or go mod tidy to download and install the new dependencies and update your application's go.mod file.

In the example above, the globalsearchv2 part of the import path is the package name associated with the Global Search service. See the service table above to find the approprate package name for the services used by your application.

go get command

Alternatively, you can use the go get command to download and install the appropriate packages needed by your application:

go get -u github.com/IBM/platform-services-go-sdk/globalsearchv2

Be sure to use the appropriate package name from the service table above for the services used by your application.

Using the SDK

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

The IBM Cloud Platform Services Go SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.