license

Get all licenses

Securityapi_key
Request
query Parameters
jdbc_driver_id
integer <int32>

The JDBC driver Id to get the license

page_number
integer <int64>
Default: 1

The page number for which to get licences. 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 property if not provided

Responses
200

Success

403

Forbidden access

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

Create license

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
Request Body schema: multipart/form-data
required
licenseFile
required
string <binary>

The license file to be uploaded. The logical name of the license will be exactly the name of this uploaded file

licenseType
required
string

The type of the license file being uploaded

Value: "JDBC_DRIVER"
jdbcDriverId
required
integer <int32>

The ID number of the JDBC driver.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/license
Response samples
application/json
{
  • "licenseId": "3",
  • "licenseFileName": "license.bin",
  • "licenseType": "JDBC_DRIVER",
  • "jdbcDriverId": "1",
  • "createdTime": "2023-03-15T12:16:35.964Z"
}

Get license by ID

Securityapi_key
Request
path Parameters
licenseId
required
integer <int32>

The ID of the license to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/license/{licenseId}
Response samples
application/json
{
  • "licenseId": "3",
  • "licenseFileName": "license.bin",
  • "licenseType": "JDBC_DRIVER",
  • "jdbcDriverId": "1",
  • "createdTime": "2023-03-15T12:16:35.964Z"
}

Delete license by ID

Securityapi_key
Request
path Parameters
licenseId
required
integer <int32>

The ID of the license to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/license/{licenseId}
➔ Next to login