Jump to

• Request
• Response

Update SFTP Service Configuration

put

{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/services/sftp/configuration

Update SFTP service configuration

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

sftpServerConfiguration

Root Schema : schema

Type: object

Show Source

• sftpconfig: object SFTPConfig
  Describes configuration of SFTP server.
• SFTPConfig(required): object SFTPConfig
  Describes configuration of SFTP server.

{
    "required":[
        "SFTPConfig"
    ],
    "type":"object",
    "properties":{
        "sftpconfig":{
            "$ref":"#/components/schemas/SFTPConfig"
        },
        "SFTPConfig":{
            "$ref":"#/components/schemas/SFTPConfig"
        }
    },
    "xml":{
        "name":"servicesConfig"
    }
}

Nested Schema : SFTPConfig

Type: object

Describes configuration of SFTP server.

Show Source

• authType(required): string
  Default Value: password or key

  Allowed Values: [ "password", "key", "password or key" ]

  Type of Authentication method(s) supported
• idleTimeout: integer (int32)
  SFTP server timeout
• ip: string
  Read Only: true

  SFTP server ip
• port: integer (int32)
  SFTP server port
• securityConfig(required): object SecurityConfig

{
    "required":[
        "authType",
        "securityConfig"
    ],
    "type":"object",
    "properties":{
        "securityConfig":{
            "$ref":"#/components/schemas/SecurityConfig"
        },
        "authType":{
            "type":"string",
            "description":"Type of Authentication method(s) supported",
            "xml":{
                "attribute":true
            },
            "default":"password or key",
            "enum":[
                "password",
                "key",
                "password or key"
            ]
        },
        "port":{
            "type":"integer",
            "description":"SFTP server port",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "ip":{
            "type":"string",
            "description":"SFTP server ip",
            "readOnly":true,
            "xml":{
                "attribute":true
            }
        },
        "idleTimeout":{
            "type":"integer",
            "description":"SFTP server timeout",
            "format":"int32",
            "xml":{
                "name":"Idle time in seconds after which server will close the connection if the client does not respond",
                "attribute":true
            }
        }
    },
    "description":"Describes configuration of SFTP server."
}

Nested Schema : SecurityConfig

Type: object

Show Source

• cipherSuites: string
  Comma separated values of all configured Cipher Suites. AllowableValues = {"aes256-ctr","aes192-ctr","aes128-ctr"}
• compressionMethods: string
  Comma separated values of all configured Compression Methods. AllowableValues = {"Zlib","[e-mail]","No Compression"}
• keyExchangeAlgorithms: string
  Comma separated values of all configured Key Exchange algorithms. AllowableValues = {"diffie-hellman-group-exchange-sha256","diffie-hellman-group14-sha1"}
• messageAuthenticationAlgorithms: string
  Comma separated values of all configured Message Authentication algorithms. AllowableValues = {"hmac-sha2-512","hmac-sha2-256"}
• signatureAlgorithms: string
  Comma separated values of all configured Signature Algorithms. AllowableValues = {"ssh-rsa","ssh-ed25519","ecdsa-sha2-nistp256","ecdsa-sha2-nistp384","ecdsa-sha2-nistp521","rsa-sha2-256","rsa-sha2-512"}

{
    "type":"object",
    "properties":{
        "cipherSuites":{
            "type":"string",
            "description":"Comma separated values of all configured Cipher Suites. AllowableValues = {\"aes256-ctr\",\"aes192-ctr\",\"aes128-ctr\"}",
            "xml":{
                "attribute":true
            }
        },
        "keyExchangeAlgorithms":{
            "type":"string",
            "description":"Comma separated values of all configured Key Exchange algorithms. AllowableValues = {\"diffie-hellman-group-exchange-sha256\",\"diffie-hellman-group14-sha1\"}",
            "xml":{
                "attribute":true
            }
        },
        "messageAuthenticationAlgorithms":{
            "type":"string",
            "description":"Comma separated values of all configured Message Authentication algorithms. AllowableValues = {\"hmac-sha2-512\",\"hmac-sha2-256\"}",
            "xml":{
                "attribute":true
            }
        },
        "signatureAlgorithms":{
            "type":"string",
            "description":"Comma separated values of all configured Signature Algorithms. AllowableValues = {\"ssh-rsa\",\"ssh-ed25519\",\"ecdsa-sha2-nistp256\",\"ecdsa-sha2-nistp384\",\"ecdsa-sha2-nistp521\",\"rsa-sha2-256\",\"rsa-sha2-512\"}",
            "xml":{
                "attribute":true
            }
        },
        "compressionMethods":{
            "type":"string",
            "description":"Comma separated values of all configured Compression Methods. AllowableValues = {\"Zlib\",\"[e-mail]\",\"No Compression\"}",
            "xml":{
                "attribute":true
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

Show Source

• sftpconfig: object SFTPConfig
  Describes configuration of SFTP server.
• SFTPConfig(required): object SFTPConfig
  Describes configuration of SFTP server.

{
    "required":[
        "SFTPConfig"
    ],
    "type":"object",
    "properties":{
        "sftpconfig":{
            "$ref":"#/components/schemas/SFTPConfig"
        },
        "SFTPConfig":{
            "$ref":"#/components/schemas/SFTPConfig"
        }
    },
    "xml":{
        "name":"servicesConfig"
    }
}

Nested Schema : SFTPConfig

Type: object

Describes configuration of SFTP server.

Show Source

• authType(required): string
  Default Value: password or key

  Allowed Values: [ "password", "key", "password or key" ]

  Type of Authentication method(s) supported
• idleTimeout: integer (int32)
  SFTP server timeout
• ip: string
  Read Only: true

  SFTP server ip
• port: integer (int32)
  SFTP server port
• securityConfig(required): object SecurityConfig

{
    "required":[
        "authType",
        "securityConfig"
    ],
    "type":"object",
    "properties":{
        "securityConfig":{
            "$ref":"#/components/schemas/SecurityConfig"
        },
        "authType":{
            "type":"string",
            "description":"Type of Authentication method(s) supported",
            "xml":{
                "attribute":true
            },
            "default":"password or key",
            "enum":[
                "password",
                "key",
                "password or key"
            ]
        },
        "port":{
            "type":"integer",
            "description":"SFTP server port",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "ip":{
            "type":"string",
            "description":"SFTP server ip",
            "readOnly":true,
            "xml":{
                "attribute":true
            }
        },
        "idleTimeout":{
            "type":"integer",
            "description":"SFTP server timeout",
            "format":"int32",
            "xml":{
                "name":"Idle time in seconds after which server will close the connection if the client does not respond",
                "attribute":true
            }
        }
    },
    "description":"Describes configuration of SFTP server."
}

Nested Schema : SecurityConfig

Type: object

Show Source

• cipherSuites: string
  Comma separated values of all configured Cipher Suites. AllowableValues = {"aes256-ctr","aes192-ctr","aes128-ctr"}
• compressionMethods: string
  Comma separated values of all configured Compression Methods. AllowableValues = {"Zlib","[e-mail]","No Compression"}
• keyExchangeAlgorithms: string
  Comma separated values of all configured Key Exchange algorithms. AllowableValues = {"diffie-hellman-group-exchange-sha256","diffie-hellman-group14-sha1"}
• messageAuthenticationAlgorithms: string
  Comma separated values of all configured Message Authentication algorithms. AllowableValues = {"hmac-sha2-512","hmac-sha2-256"}
• signatureAlgorithms: string
  Comma separated values of all configured Signature Algorithms. AllowableValues = {"ssh-rsa","ssh-ed25519","ecdsa-sha2-nistp256","ecdsa-sha2-nistp384","ecdsa-sha2-nistp521","rsa-sha2-256","rsa-sha2-512"}

{
    "type":"object",
    "properties":{
        "cipherSuites":{
            "type":"string",
            "description":"Comma separated values of all configured Cipher Suites. AllowableValues = {\"aes256-ctr\",\"aes192-ctr\",\"aes128-ctr\"}",
            "xml":{
                "attribute":true
            }
        },
        "keyExchangeAlgorithms":{
            "type":"string",
            "description":"Comma separated values of all configured Key Exchange algorithms. AllowableValues = {\"diffie-hellman-group-exchange-sha256\",\"diffie-hellman-group14-sha1\"}",
            "xml":{
                "attribute":true
            }
        },
        "messageAuthenticationAlgorithms":{
            "type":"string",
            "description":"Comma separated values of all configured Message Authentication algorithms. AllowableValues = {\"hmac-sha2-512\",\"hmac-sha2-256\"}",
            "xml":{
                "attribute":true
            }
        },
        "signatureAlgorithms":{
            "type":"string",
            "description":"Comma separated values of all configured Signature Algorithms. AllowableValues = {\"ssh-rsa\",\"ssh-ed25519\",\"ecdsa-sha2-nistp256\",\"ecdsa-sha2-nistp384\",\"ecdsa-sha2-nistp521\",\"rsa-sha2-256\",\"rsa-sha2-512\"}",
            "xml":{
                "attribute":true
            }
        },
        "compressionMethods":{
            "type":"string",
            "description":"Comma separated values of all configured Compression Methods. AllowableValues = {\"Zlib\",\"[e-mail]\",\"No Compression\"}",
            "xml":{
                "attribute":true
            }
        }
    }
}

400 Response

Bad request

401 Response

Unauthorized

404 Response

Configuration not found

500 Response

Internal Server Error

Back to Top