Categorygithub.com/IBM/networking-go-sdk
module
0.51.3
Repository: https://github.com/ibm/networking-go-sdk.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
0
Files
0

# README

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

IBM Cloud Networking Go SDK Version 0.51.3

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

Table of Contents

Overview

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

Service NamePackage name
Transit Gateway Servicetransitgatewayapisv1
Direct Link Servicedirectlinkv1
Direct Link Provider Servicedirectlinkproviderv2
CIS: Cachecachingapiv1
CIS: IPcisipapiv1
CIS: Custom Pagescustompagesv1
CIS: DNS Records Bulkdnsrecordbulkv1
CIS: DNS Recordsdnsrecordsv1
CIS: Firewall Access Rulesfirewallaccessrulesv1
CIS: Security Level Settingsfirewallapiv1
CIS: GLB Eventsgloballoadbalancereventsv1
CIS: GLB Monitorgloballoadbalancermonitorv1
CIS: GLB Poolsgloballoadbalancerpoolsv0
CIS: GLB Servicegloballoadbalancerv1
CIS: Page Rulespageruleapiv1
CIS: Range Applicationrangeapplicationsv1
CIS: Routingroutingv1
CIS: Rulesetsrulesetsv1
CIS: Security Eventssecurityeventsapiv1
CIS: SSL/TLSsslcertificateapiv1
CIS: User Agent Blocking Rulesuseragentblockingrulesv1
CIS: WAF Settingswafapiv1
CIS: WAF Rule Groupswafrulegroupsapiv1
CIS: WAF Rule Packageswafrulepackagesapiv1
CIS: WAF Ruleswafrulesapiv1
CIS: Zone Firewall Access Ruleszonefirewallaccessrulesv1
CIS: Zone Lockdownzonelockdownv1
CIS: Zone Rate Limitszoneratelimitsv1
CIS: Zone Settingszonessettingsv1
CIS: Zoneszonesv1
PDNS: DNS Zonesdnszonesv1 dnssvcsv1
PDNS: Resource Recordsresourcerecordsv1 dnssvcsv1
PDNS: Permitted Networkspermittednetworksfordnszonesv1 dnssvcsv1
PDNS: Global Load Balancersgloballoadbalancersv1 dnssvcsv1
PDNS: DNS Servicesdnssvcsv1

Prerequisites

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

Installation

The current version of this SDK: 0.51.3

There are a few different ways to download and install the Networking Go SDK project for use by your Go application:

go get command

Use this command to download and install the SDK to allow your Go application to use it:

go get -u github.com/IBM/networking-go-sdk

Go modules

If your application is using Go modules, you can add a suitable import to your Go application, like this:

import (
  "github.com/IBM/networking-go-sdk/transitgatewayapisv1"
  "github.com/IBM/networking-go-sdk/directlinkv1"
  "github.com/IBM/networking-go-sdk/directlinkproviderv2"
  "github.com/IBM/networking-go-sdk/cachingapiv1"
  "github.com/IBM/networking-go-sdk/cisipapiv1"
  "github.com/IBM/networking-go-sdk/custompagesv1"
  "github.com/IBM/networking-go-sdk/dnsrecordbulkv1"
  "github.com/IBM/networking-go-sdk/dnsrecordsv1"
  "github.com/IBM/networking-go-sdk/firewallaccessrulesv1"
  "github.com/IBM/networking-go-sdk/firewallapiv1"
  "github.com/IBM/networking-go-sdk/globalloadbalancereventsv1"
  "github.com/IBM/networking-go-sdk/globalloadbalancermonitorv1"
  "github.com/IBM/networking-go-sdk/globalloadbalancerpoolsv0"
  "github.com/IBM/networking-go-sdk/globalloadbalancerv1"
  "github.com/IBM/networking-go-sdk/pageruleapiv1"
  "github.com/IBM/networking-go-sdk/rangeapplicationsv1"
  "github.com/IBM/networking-go-sdk/routingv1"
  "github.com/IBM/networking-go-sdk/rulestsv1"
  "github.com/IBM/networking-go-sdk/securityeventsapiv1"
  "github.com/IBM/networking-go-sdk/sslcertificateapiv1"
  "github.com/IBM/networking-go-sdk/useragentblockingrulesv1"
  "github.com/IBM/networking-go-sdk/wafapiv1"
  "github.com/IBM/networking-go-sdk/wafrulegroupsapiv1"
  "github.com/IBM/networking-go-sdk/wafrulepackagesapiv1"
  "github.com/IBM/networking-go-sdk/wafrulesapiv1"
  "github.com/IBM/networking-go-sdk/zonefirewallaccessrulesv1"
  "github.com/IBM/networking-go-sdk/zonelockdownv1"
  "github.com/IBM/networking-go-sdk/zoneratelimitsv1"
  "github.com/IBM/networking-go-sdk/zonessettingsv1"
  "github.com/IBM/networking-go-sdk/zonesv1"
  "github.com/IBM/networking-go-sdk/dnszonesv1"
  "github.com/IBM/networking-go-sdk/resourcerecordsv1"
  "github.com/IBM/networking-go-sdk/permittednetworksfordnszonesv1"`
  "github.com/IBM/networking-go-sdk/globalloadbalancersv1"
  "github.com/IBM/networking-go-sdk/dnssvcsv1"
)

then run go mod tidy to download and install the new dependency and update your Go application's go.mod file.

dep dependency manager

If your application is using the dep dependency management tool, you can add a dependency to your Gopkg.toml file. Here is an example:

[[constraint]]
  name = "github.com/IBM/networking-go-sdk"
  version = "0.51.3"

then run dep ensure.

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.

Deprecation Notice

For deprecation notice, please see this link

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.

# Packages

Package alertsv1 : Operations and models for the AlertsV1 service.
Package authenticatedoriginpullapiv1 : Operations and models for the AuthenticatedOriginPullApiV1 service.
Package botanalyticsv1 : Operations and models for the BotAnalyticsV1 service.
Package botmanagementv1 : Operations and models for the BotManagementV1 service.
Package cachingapiv1 : Operations and models for the CachingApiV1 service.
Package cisipapiv1 : Operations and models for the CisIpApiV1 service.
No description provided by the author
Package custompagesv1 : Operations and models for the CustomPagesV1 service.
Package directlinkproviderv2 : Operations and models for the DirectLinkProviderV2 service.
Package directlinkv1 : Operations and models for the DirectLinkV1 service.
Package dnsrecordbulkv1 : Operations and models for the DnsRecordBulkV1 service.
Package dnsrecordsv1 : Operations and models for the DnsRecordsV1 service.
Package dnssvcsv1 : Operations and models for the DnsSvcsV1 service.
Package dnszonesv1 : Operations and models for the DnsZonesV1 service.
Package edgefunctionsapiv1 : Operations and models for the EdgeFunctionsApiV1 service.
Package filtersv1 : Operations and models for the FiltersV1 service.
Package firewallaccessrulesv1 : Operations and models for the FirewallAccessRulesV1 service.
Package firewallapiv1 : Operations and models for the FirewallApiV1 service.
Package firewallrulesv1 : Operations and models for the FirewallRulesV1 service.
Package globalloadbalancereventsv1 : Operations and models for the GlobalLoadBalancerEventsV1 service.
Package globalloadbalancermonitorv1 : Operations and models for the GlobalLoadBalancerMonitorV1 service.
Package globalloadbalancerpoolsv0 : Operations and models for the GlobalLoadBalancerPoolsV0 service.
Package globalloadbalancersv1 : Operations and models for the GlobalLoadBalancersV1 service Deprecated: This module is deprecated.
Package globalloadbalancerv1 : Operations and models for the GlobalLoadBalancerV1 service.
Package logpushjobsapiv1 : Operations and models for the LogpushJobsApiV1 service.
Package mtlsv1 : Operations and models for the MtlsV1 service.
Package pageruleapiv1 : Operations and models for the PageRuleApiV1 service.
Package permittednetworksfordnszonesv1 : Operations and models for the PermittedNetworksForDnsZonesV1 service Deprecated: This module is deprecated.
Package rangeapplicationsv1 : Operations and models for the RangeApplicationsV1 service.
Package resourcerecordsv1 : Operations and models for the ResourceRecordsV1 service Deprecated: This module is deprecated.
Package routingv1 : Operations and models for the RoutingV1 service.
Package rulesetsv1 : Operations and models for the RulesetsV1 service.
Package securityeventsapiv1 : Operations and models for the SecurityEventsApiV1 service.
Package sslcertificateapiv1 : Operations and models for the SslCertificateApiV1 service.
Package transitgatewayapisv1 : Operations and models for the TransitGatewayApisV1 service.
Package useragentblockingrulesv1 : Operations and models for the UserAgentBlockingRulesV1 service.
Package wafapiv1 : Operations and models for the WafApiV1 service.
Package wafrulegroupsapiv1 : Operations and models for the WafRuleGroupsApiV1 service.
Package wafrulepackagesapiv1 : Operations and models for the WafRulePackagesApiV1 service.
Package wafrulesapiv1 : Operations and models for the WafRulesApiV1 service.
Package webhooksv1 : Operations and models for the WebhooksV1 service.
Package zonefirewallaccessrulesv1 : Operations and models for the ZoneFirewallAccessRulesV1 service.
Package zonelockdownv1 : Operations and models for the ZoneLockdownV1 service.
Package zoneratelimitsv1 : Operations and models for the ZoneRateLimitsV1 service.
Package zonessettingsv1 : Operations and models for the ZonesSettingsV1 service.
Package zonesv1 : Operations and models for the ZonesV1 service.