databaseRuleset

Get all database rulesets

Securityapi_key
Request
query Parameters
environment_id
integer <int32>

The ID of the environment to get all database rulesets from

page_number
integer <int64>
Default: 1

The page number for which to get database 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

400

Bad request

403

Forbidden access

404

Not found

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

Create database ruleset

Securityapi_key
Request
Request Body schema: application/json
required

The database ruleset to create

rulesetName
required
string <= 255 characters

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

databaseConnectorId
required
integer <int32>

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

refreshDropsTables
boolean
Default: false

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

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

Get database ruleset by ID

Securityapi_key
Request
path Parameters
databaseRulesetId
required
integer <int32>

The ID of the database ruleset to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/database-rulesets/{databaseRulesetId}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "databaseConnectorId": 1
}

Update database ruleset

Securityapi_key
Request
path Parameters
databaseRulesetId
required
integer <int32>

The ID of the database ruleset to update

Request Body schema: application/json
required

The updated form of the database ruleset

rulesetName
required
string <= 255 characters

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

databaseConnectorId
required
integer <int32>

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

refreshDropsTables
boolean
Default: false

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

put/database-rulesets/{databaseRulesetId}
Request samples
application/json
{
  • "rulesetName": "Rule123",
  • "databaseConnectorId": 1
}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "databaseConnectorId": 1
}

Delete database ruleset by ID

Securityapi_key
Request
path Parameters
databaseRulesetId
required
integer <int32>

The ID of the database ruleset to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/database-rulesets/{databaseRulesetId}

Update the set of tables and their attributes associated with a database ruleset in bulk

Securityapi_key
Request
path Parameters
databaseRulesetId
required
integer <int32>

The ID of the database ruleset to update the tables for

Request Body schema: application/json
required

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

required
Array of objects (TableMetadata)
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

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

Refresh database ruleset by ID

Securityapi_key
Request
path Parameters
databaseRulesetId
required
integer <int32>

The ID of the database ruleset to refresh

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/database-rulesets/{databaseRulesetId}/refresh
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Copy database ruleset by ID

Securityapi_key
Request
path Parameters
databaseRulesetId
required
integer <int32>

The ID of the database 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/database-rulesets/{databaseRulesetId}/copy
Request samples
application/json
{
  • "newRulesetName": "Rule123"
}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "databaseConnectorId": 1
}

Export database Ruleset inventory by ID

Securityapi_key
Request
path Parameters
databaseRulesetId
required
integer <int32>

The ID of the database ruleset to import

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/database-rulesets/{databaseRulesetId}/csvExport
Request samples
application/json
{
  • "exportFileName": "my-database-ruleset.csv"
}
Response samples
application/json
{
  • "exportFileName": "my-database-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
databaseRulesetId
required
integer <int32>

The ID of the database ruleset to import

Request Body schema: multipart/form-data
required

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

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/database-rulesets/{databaseRulesetId}/csvImport
Response samples
application/json
{
  • "importStatus": "SUCCESS",
  • "message": [
    ]
}
➔ Next to domain