Skip to main content

Config for cartodb

Jobs that use the cartodb adaptor may require authentication. A "credential" for the cartodb adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "account": "openfn",
  "apiKey": "longsecretkey"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "account": {
          "title": "Account",
          "type": "string",
          "description": "CartoDB account name",
          "minLength": 1,
          "examples": [
              "openfn"
          ]
      },
      "apiKey": {
          "title": "API Key",
          "type": "string",
          "description": "CartoDB API key",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "longsecretkey"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "account",
      "apiKey"
  ]
}