Synchronizations

Retrieval of detailed information on synchronizations.

Returns the details of the synchronization for the provided data source.

get

Authorizations

basicAuth

AuthorizationstringRequired

The APIs require Basic HTTP authentication.

Query parameters

dataSourcestringRequired

Name of the data source

Responses

200

The set of data access rules to synchronize

application/json

All information needed to perform synchronization

idstringOptional

Operation id

Example: 37c8d656-cb03-4085-a3c0-2de40ec0f3f1

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error happened.

application/json

get/synchronizations/byDataSource

HTTPcURLJavaScriptPython

GET /rest/protect/v1/synchronizations/byDataSource?dataSource=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "37c8d656-cb03-4085-a3c0-2de40ec0f3f1",
  "dataAccessRuleSet": {
    "databases": [
      {
        "provider": "AWSLakeFormation",
        "providerDetails": {
          "awsRegion": "us-east-1"
        },
        "id": "2e35030a-3632-479a-8f2e-72c131afb882",
        "name": "database_name",
        "schemas": [
          {
            "id": "76549f59-b341-4bb7-abdd-9cdf98a50b1c",
            "name": "schema_name",
            "tables": [
              {
                "id": "d0dd3533-163d-4417-bcbb-4fb09e347128",
                "name": "table_name",
                "columns": [
                  {
                    "id": "03e597ce-645e-40b1-b1a0-9c322cf03533",
                    "name": "column_name",
                    "dataType": "Boolean",
                    "precision": 10,
                    "scale": 2,
                    "tags": [
                      {
                        "id": "5761adfa-9ca1-44b3-8a45-36d78f69d2b4",
                        "name": "PII"
                      }
                    ],
                    "accesses": [
                      {
                        "group": "Engineering",
                        "access": "Read",
                        "masking": {
                          "type": "Default"
                        },
                        "rowFilter": {
                          "operator": "Equals",
                          "values": [
                            "US"
                          ]
                        }
                      }
                    ]
                  }
                ],
                "accesses": [
                  {
                    "group": "Engineering",
                    "access": "Read"
                  }
                ]
              }
            ]
          }
        ],
        "tags": [
          {
            "id": "8761adfa-9ca1-44b3-8a45-36d78f69d2b4",
            "name": "tag_name",
            "maskings": [
              {
                "group": "Engineering",
                "masking": {
                  "type": "Default"
                }
              }
            ]
          }
        ],
        "customMaskings": [
          {
            "id": "4265adfa-9ca1-44b3-8a45-36d78f69d2b4",
            "name": "database_custom_masking",
            "mappings": []
          }
        ]
      }
    ]
  }
}