Data Policies
Fetches the configured topic creation policy. A default one will be returned if no one exists
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/v1/kafka/topic/policy HTTP/1.1
Host:
Accept: */*
{
"config": {
"partitions": {
"min": 1,
"max": 1
},
"replication": {
"min": 1,
"max": 1
},
"retention": {
"size": {
"default": 1,
"max": 1
},
"time": {
"default": 1,
"max": 1
}
}
},
"naming": {
"pattern": "text",
"description": "text"
},
"isApplicable": true
}Sets the topic creation policy
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
PUT /api/v1/environments/{name}/proxy/api/v1/kafka/topic/policy HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"config": {
"partitions": {
"min": 1
},
"replication": {
"min": 1
},
"retention": {
"size": {
"max": -1
},
"time": {
"max": -1
}
}
},
"naming": {
"pattern": "(prd|stg|dev)-.*",
"description": "Env prefixed topic name"
}
}No content
Returns all data policies obfuscation types
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/protection/static/obfuscation HTTP/1.1
Host:
Accept: */*
[
"text"
]Returns all data policies impact level types
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/protection/static/impact HTTP/1.1
Host:
Accept: */*
[
"text"
]Returns all data policies category types
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/protection/static/category HTTP/1.1
Host:
Accept: */*
[
"text"
]Returns all the data policies rules entries
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/protection/policy HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"name": "text",
"category": "text",
"impactType": "HIGH",
"obfuscation": "text",
"fields": [
"text"
],
"datasets": [
"text"
],
"versions": 1,
"lastUpdated": "text",
"lastUpdatedUser": "text",
"impact": {
"topics": [
"text"
],
"connectionEntities": [
{
"connectionName": "text",
"connectionType": "text",
"entities": [
"text"
],
"datasetsWithFields": [
{
"datasetName": "text",
"matchingKeyFields": [
{
"name": "text",
"parents": [
"text"
]
}
],
"matchingValueFields": [
{
"name": "text",
"parents": [
"text"
]
}
]
}
]
}
],
"connectors": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
],
"processors": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
],
"apps": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
]
}
}
]Adds a new data policy
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{name}/proxy/api/protection/policy HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"name": "text",
"category": "text",
"impactType": "HIGH",
"obfuscation": "text",
"fields": [
"text"
],
"datasets": [
"text"
]
}textReturns the data policy details
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/protection/policy/{id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"name": "text",
"category": "text",
"impactType": "HIGH",
"obfuscation": "text",
"fields": [
"text"
],
"datasets": [
"text"
],
"versions": 1,
"lastUpdated": "text",
"lastUpdatedUser": "text",
"impact": {
"topics": [
"text"
],
"connectionEntities": [
{
"connectionName": "text",
"connectionType": "text",
"entities": [
"text"
],
"datasetsWithFields": [
{
"datasetName": "text",
"matchingKeyFields": [
{
"name": "text",
"parents": [
"text"
]
}
],
"matchingValueFields": [
{
"name": "text",
"parents": [
"text"
]
}
]
}
]
}
],
"connectors": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
],
"processors": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
],
"apps": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
]
}
}Updates an existing data policy
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
PUT /api/v1/environments/{name}/proxy/api/protection/policy/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"id": "text",
"name": "text",
"category": "text",
"impactType": "HIGH",
"obfuscation": "text",
"fields": [
"text"
],
"datasets": [
"text"
]
}No content
Deletes an existing data policy
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
DELETE /api/v1/environments/{name}/proxy/api/protection/policy/{id} HTTP/1.1
Host:
Accept: */*
No content
Returns a data policy and its previous versions
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/protection/policy/{id}/versions HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"name": "text",
"category": "text",
"impactType": "HIGH",
"obfuscation": "text",
"fields": [
"text"
],
"datasets": [
"text"
],
"versions": 1,
"lastUpdated": "text",
"lastUpdatedUser": "text",
"impact": {
"topics": [
"text"
],
"connectionEntities": [
{
"connectionName": "text",
"connectionType": "text",
"entities": [
"text"
],
"datasetsWithFields": [
{
"datasetName": "text",
"matchingKeyFields": [
{
"name": "text",
"parents": [
"text"
]
}
],
"matchingValueFields": [
{
"name": "text",
"parents": [
"text"
]
}
]
}
]
}
],
"connectors": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
],
"processors": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
],
"apps": [
{
"id": "text",
"name": "text",
"type": "AkkaStreams"
}
]
}
}
]Loads a default set of data policies entries covering used PII fields and obfuscation rules
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{name}/proxy/api/protection/default/policy HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?