Config for progres

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

{
  "url": "https://endpoint/To/DTP",
  "key": "-----BEGIN PRIVATE KEY-----SOMETYPEOFPRIVATEVALUE-----END PRIVATE KEY-----",
  "cert": "-----BEGIN CERTIFICATE-----SOMETYPEOFVALUE-----END CERTIFICATE-----",
  "token": "[REDACTED]"
}

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": {
      "url": {
          "title": "URL",
          "type": "string",
          "description": "The Progres URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://endpoint/To/DTP"
          ]
      },
      "key": {
          "title": "Private Key",
          "type": "string",
          "description": "Your Progres private key",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "-----BEGIN PRIVATE KEY-----SOMETYPEOFPRIVATEVALUE-----END PRIVATE KEY-----"
          ]
      },
      "cert": {
          "title": "Certificate",
          "type": "string",
          "description": "Your Progres certificate",
          "minLength": 1,
          "examples": [
              "-----BEGIN CERTIFICATE-----SOMETYPEOFVALUE-----END CERTIFICATE-----"
          ]
      },
      "token": {
          "title": "Token",
          "type": "string",
          "description": "Your Progres token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "[REDACTED]"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "url",
      "key",
      "cert",
      "token"
  ]
}