ProductsDownload Community Edition

Data Policies

get

Fetches the configured topic creation policy. A default one will be returned if no one exists

Responses
200Success
application/json
get
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
}
put

Sets the topic creation policy

Body
Responses
204Success
put
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
get

Returns all data policies obfuscation types

Responses
200Success
application/json
Responsestring[]
get
GET /api/v1/environments/{name}/proxy/api/protection/static/obfuscation HTTP/1.1
Host: 
Accept: */*

[
  "text"
]
get

Returns all data policies impact level types

Responses
200Success
application/json
Responsestring[]
get
GET /api/v1/environments/{name}/proxy/api/protection/static/impact HTTP/1.1
Host: 
Accept: */*

[
  "text"
]
get

Returns all data policies category types

Responses
200Success
application/json
Responsestring[]
get
GET /api/v1/environments/{name}/proxy/api/protection/static/category HTTP/1.1
Host: 
Accept: */*

[
  "text"
]
get

Returns all the data policies rules entries

Responses
200Success
application/json
get
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"
        }
      ]
    }
  }
]
post

Adds a new data policy

Body
namestringRequired
categorystringRequired
impactTypestring · enumRequiredPossible values:
obfuscationstringRequired
fieldsstring[]Optional
datasetsstring[] · min: 1Optional
Responses
201Success
text/plain
Responsestring
post
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"
  ]
}
text
get

Returns the data policy details

Path parameters
idstringRequired
Responses
200Success
application/json
get
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"
      }
    ]
  }
}
put

Updates an existing data policy

Path parameters
idstringRequired
Body
idstringRequired
namestringRequired
categorystringRequired
impactTypestring · enumRequiredPossible values:
obfuscationstringRequired
fieldsstring[]Optional
datasetsstring[] · min: 1Optional
Responses
200Success
put
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
delete

Deletes an existing data policy

Path parameters
idstringRequired
Responses
200Success
delete
DELETE /api/v1/environments/{name}/proxy/api/protection/policy/{id} HTTP/1.1
Host: 
Accept: */*

No content
Deprecated
get

Returns a data policy and its previous versions

Path parameters
idstringRequired
Responses
200Success
application/json
get
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"
        }
      ]
    }
  }
]
post

Loads a default set of data policies entries covering used PII fields and obfuscation rules

Responses
200Success
post
POST /api/v1/environments/{name}/proxy/api/protection/default/policy HTTP/1.1
Host: 
Accept: */*

No content
PreviousSQL Query ManagementNextAlert Channels

Last updated

Was this helpful?