{"id":20695572,"url":"https://github.com/ibm-cloud/bluemix-go","last_synced_at":"2025-05-16T03:03:22.568Z","repository":{"id":39884401,"uuid":"89257570","full_name":"IBM-Cloud/bluemix-go","owner":"IBM-Cloud","description":"Go library for accessing the Bluemix API","archived":false,"fork":false,"pushed_at":"2025-04-09T01:11:33.000Z","size":3049,"stargazers_count":37,"open_issues_count":37,"forks_count":88,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-13T08:45:11.187Z","etag":null,"topics":["bluemix","cloud-foundry","golang","k8s-cluster","sdk"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IBM-Cloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-04-24T15:34:31.000Z","updated_at":"2025-04-09T01:11:36.000Z","dependencies_parsed_at":"2023-02-13T16:46:10.449Z","dependency_job_id":"1ed9c9a7-1f24-47a0-91f2-3ae1f32d8aa1","html_url":"https://github.com/IBM-Cloud/bluemix-go","commit_stats":null,"previous_names":["ibm-bluemix/bluemix-go"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Cloud%2Fbluemix-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Cloud%2Fbluemix-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Cloud%2Fbluemix-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM-Cloud%2Fbluemix-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IBM-Cloud","download_url":"https://codeload.github.com/IBM-Cloud/bluemix-go/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254459083,"owners_count":22074604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bluemix","cloud-foundry","golang","k8s-cluster","sdk"],"created_at":"2024-11-17T00:10:00.035Z","updated_at":"2025-05-16T03:03:22.518Z","avatar_url":"https://github.com/IBM-Cloud.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IBM Cloud SDK for Go\n\n[![Build Status](https://travis-ci.org/IBM-Cloud/bluemix-go.svg?branch=master)](https://travis-ci.org/IBM-Cloud/bluemix-go) [![GoDoc](https://godoc.org/github.com/IBM-Cloud/bluemix-go?status.svg)](https://godoc.org/github.com/IBM-Cloud/bluemix-go)\n\nbluemix-go provides the Go implementation for operating the IBM Cloud platform, which is based on the [Cloud Foundry API][cloudfoundry_api].\n\n## Installing\n\n1. Install the SDK using the following command\n\n```bash\ngo get github.com/IBM-Cloud/bluemix-go\n```\n\n2. Update the SDK to the latest version using the following command\n\n```bash\ngo get -u github.com/IBM-Cloud/bluemix-go\n```\n\n\n## Using the SDK\n\nYou must have a working IBM Cloud account to use the APIs. [Sign up][ibmcloud_signup] if you don't have one.\n\nThe SDK has ```examples``` folder which cites few examples on how to use the SDK.\nFirst you need to create a session.\n\n```go\nimport \"github.com/IBM-Cloud/bluemix-go/session\"\n\nfunc main(){\n\n    s := session.New()\n    .....\n}\n```\n\nCreating session in this way creates a default configuration which reads the value from the environment variables.\nYou must export the following environment variables.\n* IBMID - This is the IBM ID\n* IBMID_PASSWORD - This is the password for the above ID\n\nOR\n\n* IC_API_KEY/IBMCLOUD_API_KEY - This is the Bluemix API Key. Login to [IBMCloud][ibmcloud_login] to create one if you don't already have one. See instructions below for creating an API Key.\n\nThe default region is _us_south_. You can override it in the [Config struct][ibmcloud_go_config]. You can also provide the value via environment variables; either via _IC_REGION_ or _IBMCLOUD_REGION_. Valid regions are -\n* us-south\n* us-east\n* eu-gb\n* eu-de\n* au-syd\n* jp-tok\n\nThe maximum retries is 3. You can override it in the [Config struct][ibmcloud_go_config]. You can also provide the value via environment variable; via MAX_RETRIES\n\n## Creating an IBM Cloud API Key\n\nFirst, navigate to the IBM Cloud console and use the Manage toolbar to access IAM.\n\n![Access IAM from the Manage toolbar](.screenshots/screenshot_api_keys_iam.png)\n\nOn the left, click \"IBM Cloud API Keys\"\n\n![Click IBM Cloud API Keys](.screenshots/screenshot_api_keys_iam_left.png)\n\nPress \"Create API Key\"\n\n![Press Create API Key](.screenshots/screenshot_api_keys_create_button.png)\n\nPick a name and description for your key\n\n![Set name and description](.screenshots/screenshot_api_keys_create.png)\n\nYou have created a key! Press the eyeball to show the key. Copy or save it because keys can't be displayed or downloaded twice.\n\n![Your key is now created](.screenshots/screenshot_api_keys_create_successful.png)\n\n\n[ibmcloud_signup]: https://console.ng.bluemix.net/registration/?target=%2Fdashboard%2Fapps\n[ibmcloud_login]: https://console.ng.bluemix.net\n[ibmcloud_go_config]: https://godoc.org/github.com/IBM-Cloud/bluemix-go#Config\n[cloudfoundry_api]: https://apidocs.cloudfoundry.org/264/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibm-cloud%2Fbluemix-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fibm-cloud%2Fbluemix-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibm-cloud%2Fbluemix-go/lists"}