Steampipe unbundled →
Steampipe Hub 
Hub
Plugins
francois2metz/gandi
Overview
6Tables
Versions
GitHub
steampipe plugin install francois2metz/gandi

Gandi + Steampipe

Gandi is a registrar and an hosting company.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

For example:

select
  fqdn,
  tld,
  owner
from
  gandi_domain
+--------------------+------+---------------+
| fqdn               | tld  | owner         |
+--------------------+------+---------------+
| caresteouvert.fr   | fr   | francois2metz |
| 2metz.fr           | fr   | francois2metz |
+--------------------+------+---------------+

Documentation

Get started

Install

Download and install the latest Gandi plugin:

steampipe plugin install francois2metz/gandi

Credentials

ItemDescription
CredentialsGandi requires a token.
RadiusEach connection represents a single Gandi account.
PermissionsTokens have the same permissions as the user who creates them. The personal access token may have access to different permissions.
Resolution1. Credentials explicitly set in a steampipe config file (~/.steampipe/config/gandi.spc)
2. Credentials specified in environment variables, e.g., GANDI_TOKEN or GANDI_KEY.

Configuration

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

connection "gandi" {
    plugin = "francois2metz/gandi"


    # The Personal Access Token (create it here: https://admin.gandi.net/organizations/account/pat)
    # Permissions:
    #  - View organization
    #  - See and renew domain names
    #  - See & download SSL certificates
    # token = "YOUR_GANDI_TOKEN"


    # DEPRECATED: The API Key (get it on your account: https://account.gandi.net/)
    # key = "YOUR_GANDI_API_KEY"
}

Credentials from Environment Variables

The Gandi plugin will use the following environment variables to obtain credentials only if other argument (token or key) is not specified in the connection:

export GANDI_TOKEN=YOUR_GANDI_TOKEN
# DEPRECATED, use personal access token
export GANDI_KEY=YOUR_GANDI_API_KEY

Get Involved