GoDaddy + Steampipe

GoDaddy is a publicly traded internet domain registrar and web hosting company. It provides services such as domain registration, website hosting, website building, and email hosting for individuals and businesses.

Steampipe is an open-source zero-ETL engine to instantly query cloud APIs using SQL.

List your GoDaddy domains:

select
  domain,
  status,
  nameservers,
  privacy
from
  godaddy_domain;

+-----------------+-----------------------------------------------------+--------+---------+
| domain          | nameservers                                         | status | privacy |
+-----------------+-----------------------------------------------------+--------+---------+
| mycloudlab.in   | ["ns21.domaincontrol.com","ns22.domaincontrol.com"] | ACTIVE | false   |
+-----------------+-----------------------------------------------------+--------+---------+

Documentation

Table definitions & examples →

Quick start

Install

Download and install the latest GoDaddy plugin:

steampipe plugin install godaddy

Credentials

Item	Description
Credentials	GoDaddy requires an `API Key` and `API Secret` for all requests. Create API keys and add to `~/.steampipe/config/godaddy.spc`. GoDaddy API access is segregated for OTE (Operational Test Environment) & Production environment. Also, note that the API and secret keys used to authenticate with the production environment will not work in the OTE environment. You must generate a separate set of API keys for OTE testing. See here for information.
Radius	Each connection represents a single GoDaddy account.
Resolution	1. Credentials explicitly set in a steampipe config file (`~/.steampipe/config/godaddy.spc`) 2. Credentials specified in environment variables, e.g., `GODADDY_API_KEY`, `GODADDY_API_SECRET`and `GODADDY_ENVIRONMENT`.

Configuration

Installing the latest godaddy plugin will create a config file (~/.steampipe/config/godaddy.spc) with a single connection named godaddy:

connection "godaddy" {
  plugin = "godaddy"

  # For setting API keys see instructions at https://developer.godaddy.com/keys
  # `api_key`: The API key of the GoDaddy account. (Required).
  # This can also be set via the `GODADDY_API_KEY` environment variable.
  # api_key = "hkw647irnrhttXW_TmcsFgxJQBvLjE5L1234402"

  # `api_secret`: The secret key of the GoDaddy account. (Required).
  # This can also be set via the `GODADDY_API_SECRET` environment variable.
  # api_secret = "DjfrsqEB12345hdsieDShdjs"

  # `environment`: The type of the environment, based on the value the API endpoint will change. Possible values are: DEV | PROD. (Optional)
  # Defaults to PROD
  # This can also be set via the `GODADDY_ENVIRONMENT` environment variable.
  # environment = "PROD"
}

Alternatively, you can also use the GoDaddy environment variables to obtain credentials only if other arguments api_key api_secret and environment are not specified in the connection:

export GODADDY_API_KEY=hkw64xxxxabchttXW_TmcsFgxJQBvLjE5Lda8402
export GODADDY_API_SECRET=DjfrsqEBA4vVjsdsdsdieDShdjs
export GODADDY_ENVIRONMENT=DEV

Postgres FDW

This plugin is available as a native Postgres FDW. Unlike Steampipe CLI, which ships with an embedded Postgres server instance, the Postgres FDW can be installed in any supported Postgres database version.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_postgres_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/postgres.sh)" -- godaddy

The installer will prompt you for the plugin name and version, download and install the appropriate files for your OS, system architecture, and Postgres version.

To configure the Postgres FDW, you will create an extension, foreign server, and schema and import the foreign schema.

CREATE EXTENSION IF NOT EXISTS steampipe_postgres_godaddy;
CREATE SERVER steampipe_godaddy FOREIGN DATA WRAPPER steampipe_postgres_godaddy OPTIONS (config '<your_config>');
CREATE SCHEMA godaddy;
IMPORT FOREIGN SCHEMA godaddy FROM SERVER steampipe_godaddy INTO godaddy;

SQLite Extension

This plugin is available as a SQLite Extension, making the tables available as SQLite virtual tables.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_sqlite_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/sqlite.sh)" -- godaddy

The installer will prompt you for the plugin name, version, and destination directory. It will then determine the OS and system architecture, and it will download and install the appropriate package.

To configure the SQLite extension, load the extension module and then run the steampipe_configure_godaddy function to configure it with plugin-specific options.

$ sqlite3
sqlite> .load ./steampipe_sqlite_extension_godaddy.so
sqlite> select steampipe_configure_godaddy('<your_config>');

Export

This plugin is available as a standalone Export CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- godaddy

You can pass the configuration to the command with the --config argument:

steampipe_export_godaddy --config '<your_config>' <table_name>