Config for airqo

Jobs that use the airqo adaptor may require authentication. A "credential" for the airqo 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.

{}

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#",
  "type": "object",
  "additionalProperties": false,
  "required": [
      "token"
  ],
  "properties": {
      "token": {
          "type": "string",
          "title": "Access Token",
          "description": "AirQo API access token. Generate one via analytics.airqo.net under Account Settings > API."
      },
      "clientSecret": {
          "type": "string",
          "title": "Client Secret",
          "description": "Optional AirQo client secret sent as the X-Client-Secret header when client-secret protection is enabled."
      },
      "baseUrl": {
          "type": "string",
          "title": "Base URL",
          "description": "AirQo API base URL. Defaults to https://api.airqo.net/api/v2",
          "default": "https://api.airqo.net/api/v2"
      }
  }
}