fileRuleset

Get all file rulesets

Securityapi_key
Request
query Parameters
environment_id
integer <int32>

The ID of the environment to get all file rulesets from

page_number
integer <int64>
Default: 1

The page number for which to get file rulesets. 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

Responses
200

Success

403

Forbidden access

404

Not found

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

Create file ruleset

Securityapi_key
Request
Request Body schema: application/json
required

The file ruleset to create

rulesetName
required
string <= 255 characters

The name of the ruleset. This must be unique within an environment.

fileConnectorId
required
integer <int32>

The ID of the file connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/file-rulesets
Request samples
application/json
{
  • "rulesetName": "Rule123",
  • "fileConnectorId": 1
}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "fileConnectorId": 1
}

Get file ruleset by ID

Securityapi_key
Request
path Parameters
fileRulesetId
required
integer <int32>

The ID of the file ruleset to get

Responses
200

Success

403

Forbidden access

404

Not found

get/file-rulesets/{fileRulesetId}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "fileConnectorId": 1
}

Delete file ruleset by ID

Securityapi_key
Request
path Parameters
fileRulesetId
required
integer <int32>

The ID of the file ruleset to delete

Responses
200

Success

403

Forbidden access

404

Not found

delete/file-rulesets/{fileRulesetId}

Update the set of files and their attributes associated with a file ruleset in bulk

Securityapi_key
Request
path Parameters
fileRulesetId
required
integer <int32>

The ID of the file ruleset to update the file for

Request Body schema: application/json
required

The exact list of files to put in the ruleset. Note that existing files for this ruleset not in this list will be deleted

required
Array of objects (FileMetadata)
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/file-rulesets/{fileRulesetId}/bulk-file-update
Request samples
application/json
{
  • "fileMetadata": [
    ]
}
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Copy file ruleset by ID

Securityapi_key
Request
path Parameters
fileRulesetId
required
integer <int32>

The ID of the file ruleset to copy

Request Body schema: application/json
required

The name of the ruleset. This must be unique within an environment.

newRulesetName
required
string <= 255 characters

The name of the ruleset. This must be unique within an environment.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/file-rulesets/{fileRulesetId}/copy
Request samples
application/json
{
  • "newRulesetName": "Rule123"
}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "fileConnectorId": 1
}

Export file ruleset by ID

Securityapi_key
Request
path Parameters
fileRulesetId
required
integer <int32>

The ID of the file ruleset to export

Request Body schema: application/json
required

The name of the exported file

exportFileName
required
string <= 50 characters

The name of the exported ruleset CSV file.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/file-rulesets/{fileRulesetId}/csvExport
Request samples
application/json
{
  • "exportFileName": "my-delimited-file-ruleset.csv"
}
Response samples
application/json
{
  • "exportFileName": "my-delimited-file-ruleset.csv"
}

Import Ruleset inventory from CSV file

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Securityapi_key
Request
path Parameters
fileRulesetId
required
integer <int32>

The ID of the file rule-set to import

Request Body schema: multipart/form-data
required
file
required
string <binary>

The rule-set exported CSV file to be imported.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

put/file-rulesets/{fileRulesetId}/csvImport
Response samples
application/json
{
  • "importStatus": "SUCCESS",
  • "message": [
    ]
}
➔ Next to fileUpload