Config for sftp

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

{
  "host": "191.173.128.88",
  "port": "22",
  "username": "admin",
  "password": "@some(!)Strongpassword"
}

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": {
      "host": {
          "title": "Host URL",
          "type": "string",
          "description": "The SFTP server host url or ip address",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "191.173.128.88"
          ]
      },
      "port": {
          "title": "Port",
          "type": "integer",
          "default": 21,
          "description": "The SFTP server port",
          "minLength": 1,
          "examples": [
              22
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "Username",
          "minLength": 1,
          "examples": [
              "admin"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Password",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@some(!)Strongpassword"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "host"
  ]
}