# Test Mainframe Dataset connector by ID

WARNING: There is a known bug in the API Client where it is impossible to submit a request with an 'empty' body. As such, only the 'full' body variant of this endpoint can be used through the API Client. To use the 'empty' body variant of this endpoint, please do not use the API Client, but instead use curl or some other method of issuing HTTP requests.

Endpoint: POST /mainframe-dataset-connectors/{mainframeDatasetConnectorId}/test
Version: 5.1.41
Security: api_key

## Path parameters:

  - `mainframeDatasetConnectorId` (integer, required)
    The ID of the Mainframe Dataset connector to test

## Request fields (application/json):

  - `connectorName` (string, required)
    The name of the Mainframe Dataset connector.
    Example: "mainframe_dataset_connector_via_sftp"

  - `environmentId` (integer, required)
    The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.
    Example: 123

  - `connectionInfo` (object, required)

  - `connectionInfo.connectionMode` (string, required)
    This field denotes which connection mode the connector will use to connect to the underlying files.
    Enum: "FTP", "MOUNT", "SFTP", "FTPS", "AWS_S3", "S3_COMPATIBLE", "AZURE_BLOB_STORAGE"

  - `connectionInfo.isMvsStorage` (boolean)
    This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

  - `connectionInfo.path` (string)
    This field applies to all connection modes, and it is the file system path to the desired files.

  - `connectionInfo.mountId` (integer)
    This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

  - `connectionInfo.host` (string)
    This field is the host address belonging to the FTP/SFTP server.

  - `connectionInfo.loginName` (string)
    This field is the login name to be used to authenticate with the FTP/SFTP server.

  - `connectionInfo.password` (string)
    This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

  - `connectionInfo.port` (integer)
    This field is the port number on the host address that the FTP/SFTP server is listening to.

  - `connectionInfo.sshKey` (string)
    This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

  - `connectionInfo.userDirIsRoot` (boolean)
    This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

  - `connectionInfo.awsBucketName` (string)
    This field is the bucket name for aws s3.

  - `connectionInfo.awsRegion` (string)
    This field is the region of aws s3 bucket.

  - `connectionInfo.awsAccessKey` (string)
    This field is the access key to access the s3 object.

  - `connectionInfo.awsSecretKey` (string)
    This field is the secret key to access the s3 object.

  - `connectionInfo.awsAuthType` (string)
    This field is the type of s3 authentication.

  - `connectionInfo.prefix` (string)
    This field is the prefix for filteration.

  - `connectionInfo.delimiter` (string)
    This field is the delimiter for filteration.

  - `connectionInfo.s3CompatibleDetails` (object)

  - `connectionInfo.s3CompatibleDetails.bucketName` (string)
    This field is the bucket name for s3 compatible storage.

  - `connectionInfo.s3CompatibleDetails.region` (string)
    This field is the region of s3 compatible storage bucket.

  - `connectionInfo.s3CompatibleDetails.accessKey` (string)
    This field is the access key to access the s3 compatible storage object.

  - `connectionInfo.s3CompatibleDetails.secretKey` (string)
    This field is the secret key to access the s3 compatible storage object.

  - `connectionInfo.s3CompatibleDetails.serviceEndpoint` (string)
    This field is the service endpoint for s3 compatible storage.

  - `connectionInfo.azureBlobStorageDetails` (object)

  - `connectionInfo.azureBlobStorageDetails.accountName` (string)
    This field is the account name for the Azure Storage account.

  - `connectionInfo.azureBlobStorageDetails.containerName` (string)
    This field is the name of the container in the Azure Storage account.

  - `connectionInfo.azureBlobStorageDetails.accessKey` (string)
    This field is the access key to access the Azure Storage account.

  - `connectionInfo.azureBlobStorageDetails.prefix` (string)
    This field is the prefix for filtering blobs in the container.

  - `connectionInfo.azureBlobStorageDetails.delimiter` (string)
    This field is the delimiter for filtering blobs in the container.

  - `connectionInfo.azureBlobStorageDetails.authType` (string)
    This field is the type of azure authentication.

## Response 200 fields (application/json):

  - `response` (string)
    Success or failure of the connection test.


## Response 400 fields

## Response 403 fields

## Response 404 fields