Your suggested change has been received. Thank you.

close

RESTful Data Protection APIs

Download OpenAPI specification:Download

Protect

Calls the protect API.

Calls the protect API.

Request Body schema: application/json
protection_policy_name
required
string

Protection policy to be used during the protect operation.

data
required
string

Data to be protected.

Responses

Request samples

Content type
application/json
{
  • "protection_policy_name": "protection_policy_name",
  • "data": "1234567812345678"
}

Response samples

Content type
application/json
{
  • "protected_data": "8765432187654321",
  • "external_version": "1001002"
}

Reveal

Calls the reveal API.

Calls the reveal API.

Request Body schema: application/json
protection_policy_name
required
string

Protection policy to be used during the reveal operation.

protected_data
required
string

Data to be revealed.

external_version
string

Contains version header information.

username
string

Name of the user for whom data will be revealed.

Responses

Request samples

Content type
application/json
{
  • "protection_policy_name": "protection_policy_name",
  • "protected_data": "8765432187654321",
  • "username": "user1",
  • "external_version": "1001002"
}

Response samples

Content type
application/json
{
  • "data": "1234567812345678"
}

Performance_Metrics

Calls the performance metrics API.

Calls the performance metrics API.

Responses

Response samples

Content type
text/plain
# HELP Client Information about client and application
# TYPE Client counter
Client{ID="b563e708-e031-4435-97b4-d0926ca10f30",app_name="test"} 0
# HELP promhttp_metric_handler_requests_in_flight Current number of scrapes being served.
# TYPE promhttp_metric_handler_requests_in_flight gauge
promhttp_metric_handler_requests_in_flight 1
# HELP promhttp_metric_handler_requests_total Total number of scrapes by HTTP status code.
# TYPE promhttp_metric_handler_requests_total counter
promhttp_metric_handler_requests_total{code="200"} 2
promhttp_metric_handler_requests_total{code="500"} 0
promhttp_metric_handler_requests_total{code="503"} 0
# HELP protect_bulk_failure_count The total count of failed protect bulk APIs.
# TYPE protect_bulk_failure_count counter
protect_bulk_failure_count 0
# HELP protect_bulk_failure_transaction_count The total count of failed protect calls in the protect bulk API.    
# TYPE protect_bulk_failure_transaction_count counter
protect_bulk_failure_transaction_count 0
# HELP protect_bulk_success_count The total count of successful protect bulk API.
# TYPE protect_bulk_success_count counter
protect_bulk_success_count 0
# HELP protect_bulk_success_transaction_count The total count of successful protect calls in the protect bulk API.
# TYPE protect_bulk_success_transaction_count counter
protect_bulk_success_transaction_count 0
# HELP protect_failure_count The total count of failed protect APIs.
# TYPE protect_failure_count counter
protect_failure_count 0
# HELP protect_success_count The total count of successful protect APIs. 
# TYPE protect_success_count counter
protect_success_count 0
# HELP reveal_bulk_failure_count The total count of failed reveal bulk APIs.
# TYPE reveal_bulk_failure_count counter
reveal_bulk_failure_count 0
# HELP reveal_bulk_failure_transaction_count The total count of failed reveal calls in the reveal bulk API.
# TYPE reveal_bulk_failure_transaction_count counter
reveal_bulk_failure_transaction_count 0
# HELP reveal_bulk_success_count The total count of successful reveal bulk API.
# TYPE reveal_bulk_success_count counter
reveal_bulk_success_count 0
# HELP reveal_bulk_success_transaction_count The total count of successful reveal calls in the reveal bulk API.
# TYPE reveal_bulk_success_transaction_count counter
reveal_bulk_success_transaction_count 0
# HELP reveal_failure_count The total count of failed reveal APIs.
# TYPE reveal_failure_count counter
reveal_failure_count 0
# HELP reveal_success_count The total count of successful reveal APIs.
# TYPE reveal_success_count counter
reveal_success_count 0
# HELP unique_ip_address_count The total count of unique ip
# TYPE unique_ip_address_count counter
unique_ip_address_count 0

Liveness

Calls the liveness API.

Calls the liveness API.

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Healthz

Calls the healthz API.

Calls the healthz API.

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

ProtectBulk

Rest API for Bulk Protect.

Rest API for Bulk Protect.

Request Body schema: application/json
protection_policy_name
required
string

Protection policy to be used during the Bulk Protect operation.

data_array
required
object

An array of data.

Responses

Request samples

Content type
application/json
{
  • "protection_policy_name": "protection_policy_name",
  • "data_array": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "total_count": 2,
  • "success_count": 2,
  • "error_count": 0,
  • "protected_data_array": [
    ]
}

RevealBulk

Rest API for Bulk Reveal.

Rest API for Bulk Reveal.

Request Body schema: application/json
protection_policy_name
required
string

Protection policy to be used during the Bulk Reveal operation.

username
string

Name of the user for whom data will be revealed.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "protection_policy_name": "protection_policy_name",
  • "username": "bob",
  • "protected_data_array": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "total_count": 2,
  • "success_count": 2,
  • "error_count": 0,
  • "data_array": [
    ]
}