DMZ

Create DMZ upload file destination

This method requires the DmzUploadFileDestinations:Create permission to be associated with your role.

POST

/gb/dmz-upload-file-destinations

curl --request POST \
  --url https://api.catch-e.com/gb/dmz-upload-file-destinations \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --form 'host=<string>' \
  --form 'key=<string>' \
  --form 'name=<string>' \
  --form 'password=<string>' \
  --form 'port=123' \
  --form 'type=sftp' \
  --form 'username=<string>'

{
  "configuration": {
    "host": "example.host.com.au",
    "key": "-----BEGIN PRIVATE KEY-----\nb3BlcnNzaC1sZXktdjEAAAAABG5vbmUAbAAEbm9uZQAAAAAAAAABAAAAMxAAAAtzc2gtZW\nQyNTUxOQAAACDDvsQDpk8CmiLxMw42sz1W2KYDmMj+Fl6tSa1LVuMn3AAAAJhdLgqGXS4K\nhgAAAAtzc2xtZWQyNTUxOQAAACDDvsQEjl8CmiLxMw42rz1W2KYDmMj+Fl6tSa1LVuMn3A\nAAAEA/FZ/nJv8P3YK7as9Xen7Ae5xHhjm+mFMrmr5cGKJUgsO+xAOOTwKaIvfzEjavPVbY\npgOYyP4WXq1JrUtW4yfcAAAAFHdpbGxpYW1AYWx0YWlyLmxvY2FsAQ==\n-----END PRIVATE KEY-----\n",
    "password": "example-password",
    "port": 22,
    "username": "example-user"
  },
  "dmz_upload_file_destination_id": "<string>",
  "name": "<string>",
  "status_flag": "active",
  "type": "sftp"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

hoststringrequired

Host

Required string length: 1 - 255

keystring

SSH key (private)

Note, if you hold a PGP key for file encryption purposes, do not specify that here. Use the setDmzUploadFileDestinationEncryptionKey API.

namestringrequired

Name

Required string length: 1 - 50

passwordstring

Password

portintegerrequired

Port

Required range: 1 <= x <= 65535

typeenum<string>required

Type

Available options: sftp

usernamestringrequired

Username

Required string length: 1 - 32

Response

Success

configurationobject

Show child attributes

dmz_upload_file_destination_idstring

namestring

status_flagenum<string>

Available options: active, inactive

typeenum<string>

Available options: sftp

Still need help? Ask the team