fileConnector

Get all file connectors

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get file connectors. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

environment_id
integer <int32>

The ID of the environment to get all file connectors from

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-connectors
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create file connector

Securityapi_key
Request
Request Body schema: application/json
required

The file connector to create

connectorName
required
string <= 45 characters

The name of the file connector.

environmentId
required
integer <int32>

The ID number of the environment that the file connector is in. Once the file connector is created, this field cannot be changed.

fileType
required
string

This field denotes which file type, of the several types supported, the file connector will target. Once a FileConnector object is created, its fileType cannot be changed.

Enum: "DELIMITED" "FIXED_WIDTH" "XML" "JSON" "PARQUET"
required
object (ConnectionInfo)
Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/file-connectors
Request samples
application/json
{
  • "connectorName": "file_connector_via_ftp",
  • "environmentId": 123,
  • "fileType": "DELIMITED",
  • "connectionInfo": {
    }
}
Response samples
application/json
{
  • "connectorName": "file_connector_via_ftp",
  • "environmentId": 123,
  • "fileType": "DELIMITED",
  • "connectionInfo": {
    }
}

Get file connector by ID

Securityapi_key
Request
path Parameters
fileConnectorId
required
integer <int32>

The ID of the file connector to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-connectors/{fileConnectorId}
Response samples
application/json
{
  • "connectorName": "file_connector_via_ftp",
  • "environmentId": 123,
  • "fileType": "DELIMITED",
  • "connectionInfo": {
    }
}

Update file connector by ID

Securityapi_key
Request
path Parameters
fileConnectorId
required
integer <int32>

The ID of the file connector to update

Request Body schema: application/json
required

The updated file connector

connectorName
required
string <= 45 characters

The name of the file connector.

environmentId
required
integer <int32>

The ID number of the environment that the file connector is in. Once the file connector is created, this field cannot be changed.

fileType
required
string

This field denotes which file type, of the several types supported, the file connector will target. Once a FileConnector object is created, its fileType cannot be changed.

Enum: "DELIMITED" "FIXED_WIDTH" "XML" "JSON" "PARQUET"
required
object (ConnectionInfo)
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/file-connectors/{fileConnectorId}
Request samples
application/json
{
  • "connectorName": "file_connector_via_ftp",
  • "environmentId": 123,
  • "fileType": "DELIMITED",
  • "connectionInfo": {
    }
}
Response samples
application/json
{
  • "connectorName": "file_connector_via_ftp",
  • "environmentId": 123,
  • "fileType": "DELIMITED",
  • "connectionInfo": {
    }
}

Delete file connector by ID

Deletes file connector with given ID. This will also delete all rule sets and jobs which are using this connector.

Securityapi_key
Request
path Parameters
fileConnectorId
required
integer <int32>

The ID of the file connector to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/file-connectors/{fileConnectorId}

Fetch all accessible file names

Note that even the names of files in the directory path that are not readable or writable will be returned

Securityapi_key
Request
path Parameters
fileConnectorId
required
integer <int32>

The ID of the file connector to fetch the files for

query Parameters
hideExisting
boolean

This flag specifies fetching only table names that are not already part of a particular ruleset.

rulesetId
integer <int32>

Ruleset ID to check if the file is already added. Required in case of hideExisting is set to true.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-connectors/{fileConnectorId}/fetch
Response samples
application/json
[
  • "string"
]

Test file 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.

Securityapi_key
Request
path Parameters
fileConnectorId
required
integer <int32>

The ID of the file connector to test

Request Body schema: application/json
optional

The file connector to test. This field is optional and if no password or sshkey is supplied with the connector then the password associated with the fileConnectorId will be used.

connectorName
required
string <= 45 characters

The name of the file connector.

environmentId
required
integer <int32>

The ID number of the environment that the file connector is in. Once the file connector is created, this field cannot be changed.

fileType
required
string

This field denotes which file type, of the several types supported, the file connector will target. Once a FileConnector object is created, its fileType cannot be changed.

Enum: "DELIMITED" "FIXED_WIDTH" "XML" "JSON" "PARQUET"
required
object (ConnectionInfo)
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/file-connectors/{fileConnectorId}/test
Request samples
application/json
{
  • "connectorName": "file_connector_via_ftp",
  • "environmentId": 123,
  • "fileType": "DELIMITED",
  • "connectionInfo": {
    }
}
Response samples
application/json
{
  • "response": "string"
}

Test an unsaved file connector

Securityapi_key
Request
Request Body schema: application/json
required

The file connector to test

connectorName
required
string <= 45 characters

The name of the file connector.

environmentId
required
integer <int32>

The ID number of the environment that the file connector is in. Once the file connector is created, this field cannot be changed.

fileType
required
string

This field denotes which file type, of the several types supported, the file connector will target. Once a FileConnector object is created, its fileType cannot be changed.

Enum: "DELIMITED" "FIXED_WIDTH" "XML" "JSON" "PARQUET"
required
object (ConnectionInfo)
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/file-connectors/test
Request samples
application/json
{
  • "connectorName": "file_connector_via_ftp",
  • "environmentId": 123,
  • "fileType": "DELIMITED",
  • "connectionInfo": {
    }
}
Response samples
application/json
{
  • "response": "string"
}
➔ Next to fileDownload