Introduction to DNS Services API

IBM Cloud DNS Services allow you to:

Create zones that are collections for holding domain names
Create DNS resource records under these zones
Specify access controls used for the DNS resolution of resource records on a zone-wide level
Create global load balancers to resolve hostnames to different IP addresses based on location policies.

IBM Cloud DNS Services also maintains its own world-wide set of DNS resolvers. Computer machines provisioned under IBM Cloud on an IBM Cloud network can use resource records configured through IBM Cloud DNS Services by querying IBM Cloud DNS Services' resolvers.

Public endpoints are protected by Cloudflare. TLS termination occurs on the Cloudflare edges.

https://api.dns-svcs.cloud.ibm.com

The code examples on this tab use the DNS Services Go SDK.

Installation

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

Endpoint URL

https://api.dns-svcs.cloud.ibm.com

GitHub

https://github.com/IBM/networking-go-sdk

The code examples on this tab use the DNS Services Python SDK.

Installation

pip install --upgrade "ibm-cloud-networking-services"

Endpoint URL

https://api.dns-svcs.cloud.ibm.com/v1/

GitHub

https://github.com/IBM/networking-python-sdk

The code examples on this tab use the DNS Services Java SDK.

Maven

        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>dns-svcs</artifactId>
            <version>${project.version}</version>
        </dependency>

Gradle:

compile 'com.ibm.cloud:dns-svcs:X.X.X'

Endpoint URL

https://api.dns-svcs.cloud.ibm.com

GitHub

https://github.com/IBM/networking-java-sdk

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

| HTTP error code | Description | Recovery | |-----------------|-------------|----------| | 200 | Success | The request was successful. | | 204 | Success | The resource was deleted successfully. | | 400 | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. | | 401 | Unauthorized | You are not authorized to make this request. | | 404 | Not Found | The requested resource could not be found or the API route doesn't exist. | | 405 | Method Not Allowed | The HTTP method is not allowed on the API route. | | 500 | Internal Server Error | An internal error occurred, your request could not be processed at the moment. Wait a few minutes and try again. |

Authentication

IBM Cloud Identity and Access Management (IAM) is the primary method to authenticate to the API.

Access to DNS Services instances for users in your account is controlled by IBM Cloud Identity and Access Management (IAM). Every user that accesses the DNS Services in your account must be assigned an access policy with an IAM role defined. Pass a bearer token in an authorization header. Tokens support authenticated requests without embedding service credentials in every call. For more information, see Managing access with IAM for DNS Services.

To get the IAM access token, replace {apikey} with your service credentials.

curl -k -X POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --header "Accept: application/json" \
  --data-urlencode "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  --data-urlencode "apikey={apikey}" \
  "https://iam.cloud.ibm.com/identity/token"

Use the obtained access token to make HTTP requests to DNS Services API.

SDK managing the IAM token. Replace {apikey} and {url}.

import (
  "github.com/IBM/go-sdk-core/v5/core"
  "github.com/IBM/networking-go-sdk/dnssvcsv1"
)

func main() {
  authenticator := &core.IamAuthenticator{
    ApiKey: "{apikey}",
  }

  options := &dnssvcsv1.DnsSvcsV1Options{
    Authenticator: authenticator,
  }

  service, err := dnssvcsv1.NewDnsSvcsV1(options)

  if err != nil {
    panic(err)
  }

  service.SetServiceURL("{url}")
}

SDK managing the IAM token. Replace {apikey} and {url}.

from ibm_cloud_networking_services import DnsSvcsV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

authenticator = IAMAuthenticator('{apikey}')
dnssvc = DnsSvcsV1(
    authenticator=authenticator
)
dnssvc.set_service_url('{url}')

SDK managing the IAM token. Replace {apikey}, {version}, {serviceName} and {url}.

package com.ibm.cloud.networking.dns_svcs.v1;

import com.ibm.cloud.networking.dns_svcs.v1;

IamAuthenticator authenticator = new IamAuthenticator("{apikey}");
DnsSvcs dnsServiceProvider = new DnsSvcs("{version}", "{serviceName}",authenticator);

You can also access the service credentials from the watsonx Assistant user interface (UI): If you cannot view the API details or the service credentials, you probably do not have Manager access to the service instance. Instead, you can create a personal API key using the IBM Cloud API keys page. For more information, see Managing user API keys.

DNS Services API | IBM Cloud API Docs