Documentation
Plugins
Sources
Gandi
Configuration

Gandi Source Plugin Configuration Reference

Example

kind: source
# Common source-plugin configuration
spec:
  name: gandi
  path: /path/to/downloaded/plugin # Buy from here: https://cloudquery.io/integrations/gandi
  registry: local
  version: "PREMIUM"
  tables: ["*"]
  destinations: ["postgresql"]

  # Gandi specific configuration
  spec:
    api_key: "${GANDI_API_KEY}"

This example syncs from Gandi to the DESTINATION_NAME destination, using api_key authentication. It reads the value of the API key from an environment variable called GANDI_API_KEY. The (top level) source spec section is described in the Source Spec Reference.

Gandi Spec

This is the (nested) spec used by the Gandi source plugin.

  • api_key (string, required): An API key to access Gandi resources. This can be generated from Gandi's Account Settings Page (opens in a new tab).

  • sharing_id (string, optional. Default: not used): This is your Gandi Organization ID if you wish to limit the queries to a specific Gandi org.

  • gandi_debug (bool, optional. Default: false): Enables verbose logging of HTTP calls made by the underlying library (opens in a new tab).

  • endpoint_url (string, optional. Default: https://api.gandi.net): Endpoint URL to make the API requests to. To use the Gandi Sandbox (opens in a new tab) API endpoint, set this to https://api.sandbox.gandi.net/.

  • timeout_secs (integer as seconds, optional. Default: 300): Default timeout for each API request. Defaults to 5 minutes.

OverviewTables