REST API | DOCS

DOCS

Join Slack Github CLI

ListDataPolicies

Lists all DataPolicies for all platforms.

get

/data-policies

Query parameters

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/data-policies'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "dataPolicies": [
    {
      "metadata": {
        "createTime": "2025-02-22T14:15:02.714Z",
        "description": "text",
        "lastApplyTime": "2025-02-22T14:15:02.714Z",
        "title": "text",
        "updateTime": "2025-02-22T14:15:02.714Z",
        "version": 1,
        "tags": [
          "text"
        ]
      },
      "source": {
        "fields": [
          {
            "required": true,
            "type": "text",
            "nameParts": [
              "text"
            ],
            "tags": [
              "text"
            ]
          }
        ],
        "tags": [
          "text"
        ],
        "ref": {
          "catalog": "[Circular Reference]",
          "integrationFqn": "text",
          "platform": {
            "id": "text",
            "platformType": "PLATFORM_TYPE_UNSPECIFIED"
          },
          "resourcePath": [
            {
              "displayName": "text",
              "isLeaf": true,
              "name": "text",
              "platformName": "text"
            }
          ]
        }
      },
      "ruleSets": [
        {
          "target": {
            "type": "TARGET_TYPE_UNSPECIFIED",
            "ref": "[Circular Reference]"
          },
          "fieldTransforms": [
            {
              "field": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              },
              "transforms": [
                {
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ],
                  "aggregation": {
                    "avg": {
                      "castTo": "text",
                      "precision": 1
                    },
                    "max": {},
                    "min": {},
                    "sum": {},
                    "partitionBy": [
                      {
                        "required": true,
                        "type": "text",
                        "nameParts": [
                          "text"
                        ],
                        "tags": [
                          "text"
                        ]
                      }
                    ]
                  },
                  "detokenize": {
                    "tokenSourceRef": "text",
                    "tokenField": {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    },
                    "valueField": {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    }
                  },
                  "fixed": {
                    "value": "text"
                  },
                  "hash": {
                    "seed": "text"
                  },
                  "identity": {},
                  "nullify": {},
                  "numericRounding": {
                    "ceil": {
                      "divisor": 1
                    },
                    "floor": {
                      "divisor": 1
                    },
                    "round": {
                      "divisor": 1,
                      "precision": 1
                    }
                  },
                  "regexp": {
                    "regexp": "text",
                    "replacement": "text"
                  },
                  "sqlStatement": {
                    "statement": "text"
                  }
                }
              ]
            }
          ],
          "filters": [
            {
              "genericFilter": {
                "conditions": [
                  {
                    "condition": "text",
                    "principals": [
                      {
                        "group": "text",
                        "permission": "text",
                        "role": "text"
                      }
                    ]
                  }
                ]
              },
              "retentionFilter": {
                "conditions": [
                  {
                    "principals": [
                      {
                        "group": "text",
                        "permission": "text",
                        "role": "text"
                      }
                    ],
                    "period": {
                      "days": "text"
                    }
                  }
                ],
                "field": {
                  "required": true,
                  "type": "text",
                  "nameParts": [
                    "text"
                  ],
                  "tags": [
                    "text"
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

ListCatalogs

Lists all configured catalogs.

get

/v1alpha/catalogs

Query parameters

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/catalogs'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "catalogs": [
    {
      "id": "text",
      "type": "TYPE_UNSPECIFIED",
      "databases": [
        {
          "catalog": {
            "id": "text",
            "type": "TYPE_UNSPECIFIED",
            "databases": "[Circular Reference]",
            "tags": [
              "text"
            ]
          },
          "displayName": "text",
          "id": "text",
          "processingPlatform": {
            "id": "text",
            "platformType": "PLATFORM_TYPE_UNSPECIFIED"
          },
          "type": "text",
          "schemas": [
            "[Circular Reference]"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

GetBlueprintPolicy

Returns a data policy without any rule sets, based on the given table's data structure in the catalog. Extend this blueprint policy with field transforms and/or rule sets to create a complete data policy. Use the UpsertDataPolicy endpoint to save and enforce the policy.

get

/v1alpha/catalogs/{catalogId}/blueprint-policy

Path parameters

catalogIdstringrequired

Query parameters

databaseIdstring

schemaIdstring

tableIdstring

fqnstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/catalogs/{catalogId}/blueprint-policy'

200

default

{
  "dataPolicy": {
    "metadata": {
      "createTime": "2025-02-22T14:15:02.714Z",
      "description": "text",
      "lastApplyTime": "2025-02-22T14:15:02.714Z",
      "title": "text",
      "updateTime": "2025-02-22T14:15:02.714Z",
      "version": 1,
      "tags": [
        "text"
      ]
    },
    "source": {
      "fields": [
        {
          "required": true,
          "type": "text",
          "nameParts": [
            "text"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ],
      "ref": {
        "catalog": "[Circular Reference]",
        "integrationFqn": "text",
        "platform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "resourcePath": [
          {
            "displayName": "text",
            "isLeaf": true,
            "name": "text",
            "platformName": "text"
          }
        ]
      }
    },
    "ruleSets": [
      {
        "target": {
          "type": "TARGET_TYPE_UNSPECIFIED",
          "ref": "[Circular Reference]"
        },
        "fieldTransforms": [
          {
            "field": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            },
            "transforms": [
              {
                "principals": [
                  {
                    "group": "text",
                    "permission": "text",
                    "role": "text"
                  }
                ],
                "aggregation": {
                  "avg": {
                    "castTo": "text",
                    "precision": 1
                  },
                  "max": {},
                  "min": {},
                  "sum": {},
                  "partitionBy": [
                    {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    }
                  ]
                },
                "detokenize": {
                  "tokenSourceRef": "text",
                  "tokenField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  },
                  "valueField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  }
                },
                "fixed": {
                  "value": "text"
                },
                "hash": {
                  "seed": "text"
                },
                "identity": {},
                "nullify": {},
                "numericRounding": {
                  "ceil": {
                    "divisor": 1
                  },
                  "floor": {
                    "divisor": 1
                  },
                  "round": {
                    "divisor": 1,
                    "precision": 1
                  }
                },
                "regexp": {
                  "regexp": "text",
                  "replacement": "text"
                },
                "sqlStatement": {
                  "statement": "text"
                }
              }
            ]
          }
        ],
        "filters": [
          {
            "genericFilter": {
              "conditions": [
                {
                  "condition": "text",
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ]
                }
              ]
            },
            "retentionFilter": {
              "conditions": [
                {
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ],
                  "period": {
                    "days": "text"
                  }
                }
              ],
              "field": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            }
          }
        ]
      }
    ]
  },
  "violation": {
    "description": "text",
    "field": "text"
  }
}

ListDatabases

Lists all databases for the given catalog.

get

/v1alpha/catalogs/{catalogId}/databases

Path parameters

catalogIdstringrequired

Query parameters

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/catalogs/{catalogId}/databases'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "databases": [
    {
      "catalog": {
        "id": "text",
        "type": "TYPE_UNSPECIFIED",
        "databases": "[Circular Reference]",
        "tags": [
          "text"
        ]
      },
      "displayName": "text",
      "id": "text",
      "processingPlatform": {
        "id": "text",
        "platformType": "PLATFORM_TYPE_UNSPECIFIED"
      },
      "type": "text",
      "schemas": [
        {
          "database": {
            "catalog": {
              "id": "text",
              "type": "TYPE_UNSPECIFIED",
              "databases": "[Circular Reference]",
              "tags": [
                "text"
              ]
            },
            "displayName": "text",
            "id": "text",
            "processingPlatform": {
              "id": "text",
              "platformType": "PLATFORM_TYPE_UNSPECIFIED"
            },
            "type": "text",
            "schemas": "[Circular Reference]",
            "tags": [
              "text"
            ]
          },
          "id": "text",
          "name": "text",
          "tables": [
            "[Circular Reference]"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

ListSchemas

Lists all schemas (for a given database, if applicable).

get

/v1alpha/catalogs/{catalogId}/schemas

Path parameters

catalogIdstringrequired

Query parameters

databaseIdstring

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/catalogs/{catalogId}/schemas'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "schemas": [
    {
      "database": {
        "catalog": {
          "id": "text",
          "type": "TYPE_UNSPECIFIED",
          "databases": "[Circular Reference]",
          "tags": [
            "text"
          ]
        },
        "displayName": "text",
        "id": "text",
        "processingPlatform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "type": "text",
        "schemas": "[Circular Reference]",
        "tags": [
          "text"
        ]
      },
      "id": "text",
      "name": "text",
      "tables": [
        {
          "id": "text",
          "name": "text",
          "tags": [
            "text"
          ],
          "schema": "[Circular Reference]"
        }
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

ListTables

Lists all tables (for a given schema and database, if applicable).

get

/v1alpha/catalogs/{catalogId}/tables

Path parameters

catalogIdstringrequired

Query parameters

databaseIdstring

schemaIdstring

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/catalogs/{catalogId}/tables'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "tables": [
    {
      "id": "text",
      "name": "text",
      "tags": [
        "text"
      ],
      "schema": {
        "database": {
          "catalog": {
            "id": "text",
            "type": "TYPE_UNSPECIFIED",
            "databases": "[Circular Reference]",
            "tags": [
              "text"
            ]
          },
          "displayName": "text",
          "id": "text",
          "processingPlatform": {
            "id": "text",
            "platformType": "PLATFORM_TYPE_UNSPECIFIED"
          },
          "type": "text",
          "schemas": "[Circular Reference]",
          "tags": [
            "text"
          ]
        },
        "id": "text",
        "name": "text",
        "tables": [
          {
            "id": "text",
            "name": "text",
            "tags": [
              "text"
            ],
            "schema": "[Circular Reference]"
          }
        ],
        "tags": [
          "text"
        ]
      }
    }
  ]
}

UpsertDataPolicy

Creates or updates a DataPolicy in PACE and optionally applies it to the processing platform.

post

/v1alpha/data-policies

Body

applyboolean

whether to apply the policy directly on the processing platform if omitted, defaults to false

dataPolicyobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1alpha/data-policies' \
  --header 'Content-Type: application/json' \
  --data '{"dataPolicy":{"metadata":{"createTime":"2025-02-22T14:15:02.714Z","description":"text","lastApplyTime":"2025-02-22T14:15:02.714Z","title":"text","updateTime":"2025-02-22T14:15:02.714Z","version":1,"tags":["text"]},"source":{"fields":[{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}],"tags":["text"],"ref":{"catalog":"[Circular Reference]","integrationFqn":"text","platform":{"id":"text","platformType":"PLATFORM_TYPE_UNSPECIFIED"},"resourcePath":[{"displayName":"text","isLeaf":true,"name":"text","platformName":"text"}]}},"ruleSets":[{"target":{"type":"TARGET_TYPE_UNSPECIFIED","ref":"[Circular Reference]"},"fieldTransforms":[{"field":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]},"transforms":[{"principals":[{"group":"text","permission":"text","role":"text"}],"aggregation":{"avg":{"castTo":"text","precision":1},"max":{},"min":{},"sum":{},"partitionBy":[{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}]},"detokenize":{"tokenSourceRef":"text","tokenField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]},"valueField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}},"fixed":{"value":"text"},"hash":{"seed":"text"},"identity":{},"nullify":{},"numericRounding":{"ceil":{"divisor":1},"floor":{"divisor":1},"round":{"divisor":1,"precision":1}},"regexp":{"regexp":"text","replacement":"text"},"sqlStatement":{"statement":"text"}}]}],"filters":[{"genericFilter":{"conditions":[{"condition":"text","principals":[{"group":"text","permission":"text","role":"text"}]}]},"retentionFilter":{"conditions":[{"principals":[{"group":"text","permission":"text","role":"text"}],"period":{"days":"text"}}],"field":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}}}]}]}}'

200

default

{
  "dataPolicy": {
    "metadata": {
      "createTime": "2025-02-22T14:15:02.714Z",
      "description": "text",
      "lastApplyTime": "2025-02-22T14:15:02.714Z",
      "title": "text",
      "updateTime": "2025-02-22T14:15:02.714Z",
      "version": 1,
      "tags": [
        "text"
      ]
    },
    "source": {
      "fields": [
        {
          "required": true,
          "type": "text",
          "nameParts": [
            "text"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ],
      "ref": {
        "catalog": "[Circular Reference]",
        "integrationFqn": "text",
        "platform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "resourcePath": [
          {
            "displayName": "text",
            "isLeaf": true,
            "name": "text",
            "platformName": "text"
          }
        ]
      }
    },
    "ruleSets": [
      {
        "target": {
          "type": "TARGET_TYPE_UNSPECIFIED",
          "ref": "[Circular Reference]"
        },
        "fieldTransforms": [
          {
            "field": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            },
            "transforms": [
              {
                "principals": [
                  {
                    "group": "text",
                    "permission": "text",
                    "role": "text"
                  }
                ],
                "aggregation": {
                  "avg": {
                    "castTo": "text",
                    "precision": 1
                  },
                  "max": {},
                  "min": {},
                  "sum": {},
                  "partitionBy": [
                    {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    }
                  ]
                },
                "detokenize": {
                  "tokenSourceRef": "text",
                  "tokenField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  },
                  "valueField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  }
                },
                "fixed": {
                  "value": "text"
                },
                "hash": {
                  "seed": "text"
                },
                "identity": {},
                "nullify": {},
                "numericRounding": {
                  "ceil": {
                    "divisor": 1
                  },
                  "floor": {
                    "divisor": 1
                  },
                  "round": {
                    "divisor": 1,
                    "precision": 1
                  }
                },
                "regexp": {
                  "regexp": "text",
                  "replacement": "text"
                },
                "sqlStatement": {
                  "statement": "text"
                }
              }
            ]
          }
        ],
        "filters": [
          {
            "genericFilter": {
              "conditions": [
                {
                  "condition": "text",
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ]
                }
              ]
            },
            "retentionFilter": {
              "conditions": [
                {
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ],
                  "period": {
                    "days": "text"
                  }
                }
              ],
              "field": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            }
          }
        ]
      }
    ]
  }
}

ScanLineage

get

/v1alpha/data-policies/lineage

Query parameters

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/data-policies/lineage'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "lineageSummaries": [
    {
      "downstream": [
        {
          "managedByPace": true,
          "relation": "text",
          "resourceRef": {
            "catalog": "[Circular Reference]",
            "integrationFqn": "text",
            "platform": {
              "id": "text",
              "platformType": "PLATFORM_TYPE_UNSPECIFIED"
            },
            "resourcePath": [
              {
                "displayName": "text",
                "isLeaf": true,
                "name": "text",
                "platformName": "text"
              }
            ]
          },
          "fieldRelations": [
            {
              "sourceAttribute": "text",
              "targetAttribute": "text"
            }
          ]
        }
      ],
      "upstream": [
        {
          "managedByPace": true,
          "relation": "text",
          "resourceRef": {
            "catalog": "[Circular Reference]",
            "integrationFqn": "text",
            "platform": {
              "id": "text",
              "platformType": "PLATFORM_TYPE_UNSPECIFIED"
            },
            "resourcePath": [
              {
                "displayName": "text",
                "isLeaf": true,
                "name": "text",
                "platformName": "text"
              }
            ]
          },
          "fieldRelations": [
            {
              "sourceAttribute": "text",
              "targetAttribute": "text"
            }
          ]
        }
      ],
      "resourceRef": {
        "catalog": {
          "id": "text",
          "type": "TYPE_UNSPECIFIED",
          "databases": "[Circular Reference]",
          "tags": [
            "text"
          ]
        },
        "integrationFqn": "text",
        "platform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "resourcePath": [
          {
            "displayName": "text",
            "isLeaf": true,
            "name": "text",
            "platformName": "text"
          }
        ]
      }
    }
  ]
}

TranspileDataPolicy

post

/v1alpha/data-policies/transpile

Body

dataPolicyRefobject

inlineDataPolicyobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1alpha/data-policies/transpile' \
  --header 'Content-Type: application/json' \
  --data '{"dataPolicyRef":{},"inlineDataPolicy":{"metadata":{"createTime":"2025-02-22T14:15:02.714Z","description":"text","lastApplyTime":"2025-02-22T14:15:02.714Z","title":"text","updateTime":"2025-02-22T14:15:02.714Z","version":1,"tags":["text"]},"source":{"fields":[{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}],"tags":["text"],"ref":{"catalog":"[Circular Reference]","integrationFqn":"text","platform":{"id":"text","platformType":"PLATFORM_TYPE_UNSPECIFIED"},"resourcePath":[{"displayName":"text","isLeaf":true,"name":"text","platformName":"text"}]}},"ruleSets":[{"target":{"type":"TARGET_TYPE_UNSPECIFIED","ref":"[Circular Reference]"},"fieldTransforms":[{"field":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]},"transforms":[{"principals":[{"group":"text","permission":"text","role":"text"}],"aggregation":{"avg":{"castTo":"text","precision":1},"max":{},"min":{},"sum":{},"partitionBy":[{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}]},"detokenize":{"tokenSourceRef":"text","tokenField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]},"valueField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}},"fixed":{"value":"text"},"hash":{"seed":"text"},"identity":{},"nullify":{},"numericRounding":{"ceil":{"divisor":1},"floor":{"divisor":1},"round":{"divisor":1,"precision":1}},"regexp":{"regexp":"text","replacement":"text"},"sqlStatement":{"statement":"text"}}]}],"filters":[{"genericFilter":{"conditions":[{"condition":"text","principals":[{"group":"text","permission":"text","role":"text"}]}]},"retentionFilter":{"conditions":[{"principals":[{"group":"text","permission":"text","role":"text"}],"period":{"days":"text"}}],"field":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}}}]}]}}'

200

default

{
  "sql": "text"
}

GetDataPolicy

Returns the latest policy for a given id and platform.

get

/v1alpha/data-policies/{dataPolicyId}//{platformId}

Path parameters

dataPolicyIdstringrequired

platformIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/data-policies/{dataPolicyId}/{platformId}'

200

default

{
  "dataPolicy": {
    "metadata": {
      "createTime": "2025-02-22T14:15:02.714Z",
      "description": "text",
      "lastApplyTime": "2025-02-22T14:15:02.714Z",
      "title": "text",
      "updateTime": "2025-02-22T14:15:02.714Z",
      "version": 1,
      "tags": [
        "text"
      ]
    },
    "source": {
      "fields": [
        {
          "required": true,
          "type": "text",
          "nameParts": [
            "text"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ],
      "ref": {
        "catalog": "[Circular Reference]",
        "integrationFqn": "text",
        "platform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "resourcePath": [
          {
            "displayName": "text",
            "isLeaf": true,
            "name": "text",
            "platformName": "text"
          }
        ]
      }
    },
    "ruleSets": [
      {
        "target": {
          "type": "TARGET_TYPE_UNSPECIFIED",
          "ref": "[Circular Reference]"
        },
        "fieldTransforms": [
          {
            "field": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            },
            "transforms": [
              {
                "principals": [
                  {
                    "group": "text",
                    "permission": "text",
                    "role": "text"
                  }
                ],
                "aggregation": {
                  "avg": {
                    "castTo": "text",
                    "precision": 1
                  },
                  "max": {},
                  "min": {},
                  "sum": {},
                  "partitionBy": [
                    {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    }
                  ]
                },
                "detokenize": {
                  "tokenSourceRef": "text",
                  "tokenField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  },
                  "valueField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  }
                },
                "fixed": {
                  "value": "text"
                },
                "hash": {
                  "seed": "text"
                },
                "identity": {},
                "nullify": {},
                "numericRounding": {
                  "ceil": {
                    "divisor": 1
                  },
                  "floor": {
                    "divisor": 1
                  },
                  "round": {
                    "divisor": 1,
                    "precision": 1
                  }
                },
                "regexp": {
                  "regexp": "text",
                  "replacement": "text"
                },
                "sqlStatement": {
                  "statement": "text"
                }
              }
            ]
          }
        ],
        "filters": [
          {
            "genericFilter": {
              "conditions": [
                {
                  "condition": "text",
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ]
                }
              ]
            },
            "retentionFilter": {
              "conditions": [
                {
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ],
                  "period": {
                    "days": "text"
                  }
                }
              ],
              "field": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            }
          }
        ]
      }
    ]
  }
}

ApplyDataPolicy

Applies an existing DataPolicy to the processing platform.

post

/v1alpha/data-policies/{dataPolicyId}//{platformId}

Path parameters

dataPolicyIdstringrequired

platformIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1alpha/data-policies/{dataPolicyId}/{platformId}'

200

default

{
  "dataPolicy": {
    "metadata": {
      "createTime": "2025-02-22T14:15:02.714Z",
      "description": "text",
      "lastApplyTime": "2025-02-22T14:15:02.714Z",
      "title": "text",
      "updateTime": "2025-02-22T14:15:02.714Z",
      "version": 1,
      "tags": [
        "text"
      ]
    },
    "source": {
      "fields": [
        {
          "required": true,
          "type": "text",
          "nameParts": [
            "text"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ],
      "ref": {
        "catalog": "[Circular Reference]",
        "integrationFqn": "text",
        "platform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "resourcePath": [
          {
            "displayName": "text",
            "isLeaf": true,
            "name": "text",
            "platformName": "text"
          }
        ]
      }
    },
    "ruleSets": [
      {
        "target": {
          "type": "TARGET_TYPE_UNSPECIFIED",
          "ref": "[Circular Reference]"
        },
        "fieldTransforms": [
          {
            "field": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            },
            "transforms": [
              {
                "principals": [
                  {
                    "group": "text",
                    "permission": "text",
                    "role": "text"
                  }
                ],
                "aggregation": {
                  "avg": {
                    "castTo": "text",
                    "precision": 1
                  },
                  "max": {},
                  "min": {},
                  "sum": {},
                  "partitionBy": [
                    {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    }
                  ]
                },
                "detokenize": {
                  "tokenSourceRef": "text",
                  "tokenField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  },
                  "valueField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  }
                },
                "fixed": {
                  "value": "text"
                },
                "hash": {
                  "seed": "text"
                },
                "identity": {},
                "nullify": {},
                "numericRounding": {
                  "ceil": {
                    "divisor": 1
                  },
                  "floor": {
                    "divisor": 1
                  },
                  "round": {
                    "divisor": 1,
                    "precision": 1
                  }
                },
                "regexp": {
                  "regexp": "text",
                  "replacement": "text"
                },
                "sqlStatement": {
                  "statement": "text"
                }
              }
            ]
          }
        ],
        "filters": [
          {
            "genericFilter": {
              "conditions": [
                {
                  "condition": "text",
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ]
                }
              ]
            },
            "retentionFilter": {
              "conditions": [
                {
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ],
                  "period": {
                    "days": "text"
                  }
                }
              ],
              "field": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            }
          }
        ]
      }
    ]
  }
}

EvaluateDataPolicy

Evaluates a previously upserted DataPolicy against a provided data sample. Platform-specific data types, transforms and nested fields are not supported.

post

/v1alpha/data-policies/{data_policy_id}//{platform_id}/evaluate

Path parameters

data_policy_idstringrequired

platform_idstringrequired

Body

dataPolicyRefobject

inlineDataPolicyobject

principalsobject[]

Evaluate a data policy for these principals against a sample of data. If left empty, the policy will be evaluated against all principals. In order to evaluate the policy for a principal that does not occur in the policy, add a principal message without the principal field set. This will be treated as the other principal.

csvSampleall of

CSV-formatted sample data to evaluate the policy against. The first row must be a header row.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1alpha/data-policies/{data_policy_id}/{platform_id}/evaluate' \
  --header 'Content-Type: application/json' \
  --data '{"dataPolicyRef":{},"inlineDataPolicy":{"metadata":{"createTime":"2025-02-22T14:15:02.714Z","description":"text","lastApplyTime":"2025-02-22T14:15:02.714Z","title":"text","updateTime":"2025-02-22T14:15:02.714Z","version":1,"tags":["text"]},"source":{"fields":[{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}],"tags":["text"],"ref":{"catalog":"[Circular Reference]","integrationFqn":"text","platform":{"id":"text","platformType":"PLATFORM_TYPE_UNSPECIFIED"},"resourcePath":[{"displayName":"text","isLeaf":true,"name":"text","platformName":"text"}]}},"ruleSets":[{"target":{"type":"TARGET_TYPE_UNSPECIFIED","ref":"[Circular Reference]"},"fieldTransforms":[{"field":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]},"transforms":[{"principals":[{"group":"text","permission":"text","role":"text"}],"aggregation":{"avg":{"castTo":"text","precision":1},"max":{},"min":{},"sum":{},"partitionBy":[{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}]},"detokenize":{"tokenSourceRef":"text","tokenField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]},"valueField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}},"fixed":{"value":"text"},"hash":{"seed":"text"},"identity":{},"nullify":{},"numericRounding":{"ceil":{"divisor":1},"floor":{"divisor":1},"round":{"divisor":1,"precision":1}},"regexp":{"regexp":"text","replacement":"text"},"sqlStatement":{"statement":"text"}}]}],"filters":[{"genericFilter":{"conditions":[{"condition":"text","principals":[{"group":"text","permission":"text","role":"text"}]}]},"retentionFilter":{"conditions":[{"principals":[{"group":"text","permission":"text","role":"text"}],"period":{"days":"text"}}],"field":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}}}]}]},"principals":[{}],"csvSample":{}}'

200

default

{
  "ruleSetResults": [
    {
      "evaluationResults": [
        {
          "csvEvaluation": {
            "csv": "text"
          },
          "principal": {
            "group": "text",
            "permission": "text",
            "role": "text"
          }
        }
      ],
      "target": {
        "type": "TARGET_TYPE_UNSPECIFIED",
        "ref": "[Circular Reference]"
      }
    }
  ]
}

ListGlobalTransforms

get

/v1alpha/global-transforms

Query parameters

typesstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/global-transforms'

200

default

{
  "globalTransforms": [
    {
      "description": "text",
      "tagTransform": {
        "tagContent": "text",
        "transforms": [
          {
            "principals": [
              {
                "group": "text",
                "permission": "text",
                "role": "text"
              }
            ],
            "aggregation": {
              "avg": {
                "castTo": "text",
                "precision": 1
              },
              "max": {},
              "min": {},
              "sum": {},
              "partitionBy": [
                {
                  "required": true,
                  "type": "text",
                  "nameParts": [
                    "text"
                  ],
                  "tags": [
                    "text"
                  ]
                }
              ]
            },
            "detokenize": {
              "tokenSourceRef": "text",
              "tokenField": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              },
              "valueField": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            },
            "fixed": {
              "value": "text"
            },
            "hash": {
              "seed": "text"
            },
            "identity": {},
            "nullify": {},
            "numericRounding": {
              "ceil": {
                "divisor": 1
              },
              "floor": {
                "divisor": 1
              },
              "round": {
                "divisor": 1,
                "precision": 1
              }
            },
            "regexp": {
              "regexp": "text",
              "replacement": "text"
            },
            "sqlStatement": {
              "statement": "text"
            }
          }
        ]
      }
    }
  ]
}

UpsertGlobalTransform

post

/v1alpha/global-transforms

Body

transformobject

If the specified transform is incompatible with the field data type to which this global transform is connected with, then the end user will get an invalid argument, and the blueprint policy with the global transforms applied won't be returned.

Global transforms are identified by an identifier of their [transform]. These are by default loose matching, so that 'Email-PII' is matched when 'email pii' is used.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1alpha/global-transforms' \
  --header 'Content-Type: application/json' \
  --data '{"transform":{"tagTransform":{"tagContent":"text","transforms":[{"principals":[{"group":"text","permission":"text","role":"text"}],"aggregation":{"avg":{"castTo":"text","precision":1},"max":{},"min":{},"sum":{},"partitionBy":[{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}]},"detokenize":{"tokenSourceRef":"text","tokenField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]},"valueField":{"required":true,"type":"text","nameParts":["text"],"tags":["text"]}},"fixed":{"value":"text"},"hash":{"seed":"text"},"identity":{},"nullify":{},"numericRounding":{"ceil":{"divisor":1},"floor":{"divisor":1},"round":{"divisor":1,"precision":1}},"regexp":{"regexp":"text","replacement":"text"},"sqlStatement":{"statement":"text"}}]}}}'

200

default

{
  "transform": {
    "description": "text",
    "tagTransform": {
      "tagContent": "text",
      "transforms": [
        {
          "principals": [
            {
              "group": "text",
              "permission": "text",
              "role": "text"
            }
          ],
          "aggregation": {
            "avg": {
              "castTo": "text",
              "precision": 1
            },
            "max": {},
            "min": {},
            "sum": {},
            "partitionBy": [
              {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            ]
          },
          "detokenize": {
            "tokenSourceRef": "text",
            "tokenField": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            },
            "valueField": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            }
          },
          "fixed": {
            "value": "text"
          },
          "hash": {
            "seed": "text"
          },
          "identity": {},
          "nullify": {},
          "numericRounding": {
            "ceil": {
              "divisor": 1
            },
            "floor": {
              "divisor": 1
            },
            "round": {
              "divisor": 1,
              "precision": 1
            }
          },
          "regexp": {
            "regexp": "text",
            "replacement": "text"
          },
          "sqlStatement": {
            "statement": "text"
          }
        }
      ]
    }
  }
}

GetGlobalTransform

get

/v1alpha/global-transforms/{ref}//{type}

Path parameters

refstringrequired

this ref refers to the primary key in the oneof transform, so its use depends on which one it is. TAG_TRANSFORM -> TagTransform.tag_content no others defined (yet).

typestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/global-transforms/{ref}/{type}'

200

default

{
  "transform": {
    "description": "text",
    "tagTransform": {
      "tagContent": "text",
      "transforms": [
        {
          "principals": [
            {
              "group": "text",
              "permission": "text",
              "role": "text"
            }
          ],
          "aggregation": {
            "avg": {
              "castTo": "text",
              "precision": 1
            },
            "max": {},
            "min": {},
            "sum": {},
            "partitionBy": [
              {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            ]
          },
          "detokenize": {
            "tokenSourceRef": "text",
            "tokenField": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            },
            "valueField": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            }
          },
          "fixed": {
            "value": "text"
          },
          "hash": {
            "seed": "text"
          },
          "identity": {},
          "nullify": {},
          "numericRounding": {
            "ceil": {
              "divisor": 1
            },
            "floor": {
              "divisor": 1
            },
            "round": {
              "divisor": 1,
              "precision": 1
            }
          },
          "regexp": {
            "regexp": "text",
            "replacement": "text"
          },
          "sqlStatement": {
            "statement": "text"
          }
        }
      ]
    }
  }
}

DeleteGlobalTransform

delete

/v1alpha/global-transforms/{ref}//{type}

Path parameters

refstringrequired

typestringrequired

Body

refstring

typestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1alpha/global-transforms/{ref}/{type}' \
  --header 'Content-Type: application/json'

200

default

{
  "deletedCount": 1
}

ListPlugins

get

/v1alpha/plugins

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/plugins'

200

default

{
  "plugins": [
    {
      "id": "text",
      "implementation": "text",
      "actions": [
        {
          "invokable": true,
          "type": "ACTION_UNSPECIFIED"
        }
      ]
    }
  ]
}

InvokePlugin

post

/v1alpha/plugins/{pluginId}/actions/{action.type}

Path parameters

pluginIdstringrequired

The identifier of the plugin to invoke.

action.typestringrequired

Body

actionobject

dataPolicyGeneratorParametersobject

pluginIdstring

The identifier of the plugin to invoke.

sampleDataGeneratorParametersobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1alpha/plugins/{pluginId}/actions/{action.type}' \
  --header 'Content-Type: application/json' \
  --data '{"action":{"type":"ACTION_UNSPECIFIED"},"dataPolicyGeneratorParameters":{},"sampleDataGeneratorParameters":{}}'

200

default

{
  "dataPolicyGeneratorResult": {
    "dataPolicy": {
      "metadata": {
        "createTime": "2025-02-22T14:15:02.714Z",
        "description": "text",
        "lastApplyTime": "2025-02-22T14:15:02.714Z",
        "title": "text",
        "updateTime": "2025-02-22T14:15:02.714Z",
        "version": 1,
        "tags": [
          "text"
        ]
      },
      "source": {
        "fields": [
          {
            "required": true,
            "type": "text",
            "nameParts": [
              "text"
            ],
            "tags": [
              "text"
            ]
          }
        ],
        "tags": [
          "text"
        ],
        "ref": {
          "catalog": "[Circular Reference]",
          "integrationFqn": "text",
          "platform": {
            "id": "text",
            "platformType": "PLATFORM_TYPE_UNSPECIFIED"
          },
          "resourcePath": [
            {
              "displayName": "text",
              "isLeaf": true,
              "name": "text",
              "platformName": "text"
            }
          ]
        }
      },
      "ruleSets": [
        {
          "target": {
            "type": "TARGET_TYPE_UNSPECIFIED",
            "ref": "[Circular Reference]"
          },
          "fieldTransforms": [
            {
              "field": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              },
              "transforms": [
                {
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ],
                  "aggregation": {
                    "avg": {
                      "castTo": "text",
                      "precision": 1
                    },
                    "max": {},
                    "min": {},
                    "sum": {},
                    "partitionBy": [
                      {
                        "required": true,
                        "type": "text",
                        "nameParts": [
                          "text"
                        ],
                        "tags": [
                          "text"
                        ]
                      }
                    ]
                  },
                  "detokenize": {
                    "tokenSourceRef": "text",
                    "tokenField": {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    },
                    "valueField": {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    }
                  },
                  "fixed": {
                    "value": "text"
                  },
                  "hash": {
                    "seed": "text"
                  },
                  "identity": {},
                  "nullify": {},
                  "numericRounding": {
                    "ceil": {
                      "divisor": 1
                    },
                    "floor": {
                      "divisor": 1
                    },
                    "round": {
                      "divisor": 1,
                      "precision": 1
                    }
                  },
                  "regexp": {
                    "regexp": "text",
                    "replacement": "text"
                  },
                  "sqlStatement": {
                    "statement": "text"
                  }
                }
              ]
            }
          ],
          "filters": [
            {
              "genericFilter": {
                "conditions": [
                  {
                    "condition": "text",
                    "principals": [
                      {
                        "group": "text",
                        "permission": "text",
                        "role": "text"
                      }
                    ]
                  }
                ]
              },
              "retentionFilter": {
                "conditions": [
                  {
                    "principals": [
                      {
                        "group": "text",
                        "permission": "text",
                        "role": "text"
                      }
                    ],
                    "period": {
                      "days": "text"
                    }
                  }
                ],
                "field": {
                  "required": true,
                  "type": "text",
                  "nameParts": [
                    "text"
                  ],
                  "tags": [
                    "text"
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  },
  "sampleDataGeneratorResult": {
    "data": "text",
    "format": "FORMAT_UNSPECIFIED"
  }
}

GetPayloadJSONSchema

get

/v1alpha/plugins/{pluginId}/actions/{action.type}/payload-json-schema

Path parameters

pluginIdstringrequired

The identifier of the plugin to get the payload json schema for

action.typestringrequired

Query parameters

action.typestring · enum

The type of action that this plugin supports

Options: ACTION_UNSPECIFIED, GENERATE_DATA_POLICY, GENERATE_SAMPLE_DATA

action.invokableboolean

Whether this action can be invoked through the API

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/plugins/{pluginId}/actions/{action.type}/payload-json-schema'

200

default

{
  "schema": "text"
}

ListProcessingPlatforms

Lists all configured processing platforms.

get

/v1alpha/processing-platforms

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/processing-platforms'

200

default

{
  "processingPlatforms": [
    {
      "id": "text",
      "platformType": "PLATFORM_TYPE_UNSPECIFIED"
    }
  ]
}

ListDatabases

Lists all databases for the given processing_platform.

get

/v1alpha/processing-platforms/{platformId}/databases

Path parameters

platformIdstringrequired

Query parameters

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/processing-platforms/{platformId}/databases'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "databases": [
    {
      "catalog": {
        "id": "text",
        "type": "TYPE_UNSPECIFIED",
        "databases": "[Circular Reference]",
        "tags": [
          "text"
        ]
      },
      "displayName": "text",
      "id": "text",
      "processingPlatform": {
        "id": "text",
        "platformType": "PLATFORM_TYPE_UNSPECIFIED"
      },
      "type": "text",
      "schemas": [
        {
          "database": {
            "catalog": {
              "id": "text",
              "type": "TYPE_UNSPECIFIED",
              "databases": "[Circular Reference]",
              "tags": [
                "text"
              ]
            },
            "displayName": "text",
            "id": "text",
            "processingPlatform": {
              "id": "text",
              "platformType": "PLATFORM_TYPE_UNSPECIFIED"
            },
            "type": "text",
            "schemas": "[Circular Reference]",
            "tags": [
              "text"
            ]
          },
          "id": "text",
          "name": "text",
          "tables": [
            "[Circular Reference]"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

ListGroups

Lists all available user groups for the given platform.

get

/v1alpha/processing-platforms/{platformId}/groups

Path parameters

platformIdstringrequired

Query parameters

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/processing-platforms/{platformId}/groups'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "groups": [
    "text"
  ]
}

ListSchemas

Lists all schemas (for a given database, if applicable).

get

/v1alpha/processing-platforms/{platformId}/schemas

Path parameters

platformIdstringrequired

Query parameters

databaseIdstring

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/processing-platforms/{platformId}/schemas'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "schemas": [
    {
      "database": {
        "catalog": {
          "id": "text",
          "type": "TYPE_UNSPECIFIED",
          "databases": "[Circular Reference]",
          "tags": [
            "text"
          ]
        },
        "displayName": "text",
        "id": "text",
        "processingPlatform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "type": "text",
        "schemas": "[Circular Reference]",
        "tags": [
          "text"
        ]
      },
      "id": "text",
      "name": "text",
      "tables": [
        {
          "id": "text",
          "name": "text",
          "tags": [
            "text"
          ],
          "schema": "[Circular Reference]"
        }
      ],
      "tags": [
        "text"
      ]
    }
  ]
}

ListTables

Lists all available table names for the given platform.

get

/v1alpha/processing-platforms/{platformId}/tables

Path parameters

platformIdstringrequired

Query parameters

databaseIdstring

schemaIdstring

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/processing-platforms/{platformId}/tables'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "tables": [
    {
      "id": "text",
      "name": "text",
      "tags": [
        "text"
      ],
      "schema": {
        "database": {
          "catalog": {
            "id": "text",
            "type": "TYPE_UNSPECIFIED",
            "databases": "[Circular Reference]",
            "tags": [
              "text"
            ]
          },
          "displayName": "text",
          "id": "text",
          "processingPlatform": {
            "id": "text",
            "platformType": "PLATFORM_TYPE_UNSPECIFIED"
          },
          "type": "text",
          "schemas": "[Circular Reference]",
          "tags": [
            "text"
          ]
        },
        "id": "text",
        "name": "text",
        "tables": [
          {
            "id": "text",
            "name": "text",
            "tags": [
              "text"
            ],
            "schema": "[Circular Reference]"
          }
        ],
        "tags": [
          "text"
        ]
      }
    }
  ]
}

GetLineage

get

/v1alpha/processing-platforms/{platformId}/tables/{fqn}/lineage

Path parameters

platformIdstringrequired

fqnstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/processing-platforms/{platformId}/tables/{fqn}/lineage'

200

default

{
  "lineageSummary": {
    "downstream": [
      {
        "managedByPace": true,
        "relation": "text",
        "resourceRef": {
          "catalog": "[Circular Reference]",
          "integrationFqn": "text",
          "platform": {
            "id": "text",
            "platformType": "PLATFORM_TYPE_UNSPECIFIED"
          },
          "resourcePath": [
            {
              "displayName": "text",
              "isLeaf": true,
              "name": "text",
              "platformName": "text"
            }
          ]
        },
        "fieldRelations": [
          {
            "sourceAttribute": "text",
            "targetAttribute": "text"
          }
        ]
      }
    ],
    "upstream": [
      {
        "managedByPace": true,
        "relation": "text",
        "resourceRef": {
          "catalog": "[Circular Reference]",
          "integrationFqn": "text",
          "platform": {
            "id": "text",
            "platformType": "PLATFORM_TYPE_UNSPECIFIED"
          },
          "resourcePath": [
            {
              "displayName": "text",
              "isLeaf": true,
              "name": "text",
              "platformName": "text"
            }
          ]
        },
        "fieldRelations": [
          {
            "sourceAttribute": "text",
            "targetAttribute": "text"
          }
        ]
      }
    ],
    "resourceRef": {
      "catalog": {
        "id": "text",
        "type": "TYPE_UNSPECIFIED",
        "databases": "[Circular Reference]",
        "tags": [
          "text"
        ]
      },
      "integrationFqn": "text",
      "platform": {
        "id": "text",
        "platformType": "PLATFORM_TYPE_UNSPECIFIED"
      },
      "resourcePath": [
        {
          "displayName": "text",
          "isLeaf": true,
          "name": "text",
          "platformName": "text"
        }
      ]
    }
  }
}

GetBlueprintPolicy

Returns a data policy without any rule sets, based on the given table's data structure in the platform. Extend this blueprint policy with field transforms and/or rule sets to create a complete data policy. Use the UpsertDataPolicy endpoint to save and enforce the policy.

get

/v1alpha/processing-platforms/{platformId}/tables/{table_id}/blueprint-policy

Path parameters

platformIdstringrequired

table_idstringrequired

Query parameters

table.idstring

The id used by the catalog.

table.namestring

table.schema.idstring

The id used by the catalog.

table.schema.namestring

table.schema.database.idstring

The id of the database

table.schema.database.typestring

table.schema.database.displayNamestring

table.schema.database.catalog.idstring

An arbitrary but unique identifier for the catalog. This matches the id from the PACE app configuration.

table.schema.database.catalog.typestring · enum

Options: TYPE_UNSPECIFIED, COLLIBRA, ODD, DATAHUB

table.schema.database.catalog.tagsstring[]

table.schema.database.processingPlatform.platformTypestring · enum

Options: PLATFORM_TYPE_UNSPECIFIED, DATABRICKS, SNOWFLAKE, BIGQUERY, POSTGRES, SYNAPSE

table.schema.database.processingPlatform.idstring

An arbitrary but unique identifier for the platform. This matches the id from the PACE app configuration.

table.schema.database.tagsstring[]

table.schema.tagsstring[]

table.tagsstring[]

fqnstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/processing-platforms/{platformId}/tables/{table_id}/blueprint-policy'

200

default

{
  "dataPolicy": {
    "metadata": {
      "createTime": "2025-02-22T14:15:02.714Z",
      "description": "text",
      "lastApplyTime": "2025-02-22T14:15:02.714Z",
      "title": "text",
      "updateTime": "2025-02-22T14:15:02.714Z",
      "version": 1,
      "tags": [
        "text"
      ]
    },
    "source": {
      "fields": [
        {
          "required": true,
          "type": "text",
          "nameParts": [
            "text"
          ],
          "tags": [
            "text"
          ]
        }
      ],
      "tags": [
        "text"
      ],
      "ref": {
        "catalog": "[Circular Reference]",
        "integrationFqn": "text",
        "platform": {
          "id": "text",
          "platformType": "PLATFORM_TYPE_UNSPECIFIED"
        },
        "resourcePath": [
          {
            "displayName": "text",
            "isLeaf": true,
            "name": "text",
            "platformName": "text"
          }
        ]
      }
    },
    "ruleSets": [
      {
        "target": {
          "type": "TARGET_TYPE_UNSPECIFIED",
          "ref": "[Circular Reference]"
        },
        "fieldTransforms": [
          {
            "field": {
              "required": true,
              "type": "text",
              "nameParts": [
                "text"
              ],
              "tags": [
                "text"
              ]
            },
            "transforms": [
              {
                "principals": [
                  {
                    "group": "text",
                    "permission": "text",
                    "role": "text"
                  }
                ],
                "aggregation": {
                  "avg": {
                    "castTo": "text",
                    "precision": 1
                  },
                  "max": {},
                  "min": {},
                  "sum": {},
                  "partitionBy": [
                    {
                      "required": true,
                      "type": "text",
                      "nameParts": [
                        "text"
                      ],
                      "tags": [
                        "text"
                      ]
                    }
                  ]
                },
                "detokenize": {
                  "tokenSourceRef": "text",
                  "tokenField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  },
                  "valueField": {
                    "required": true,
                    "type": "text",
                    "nameParts": [
                      "text"
                    ],
                    "tags": [
                      "text"
                    ]
                  }
                },
                "fixed": {
                  "value": "text"
                },
                "hash": {
                  "seed": "text"
                },
                "identity": {},
                "nullify": {},
                "numericRounding": {
                  "ceil": {
                    "divisor": 1
                  },
                  "floor": {
                    "divisor": 1
                  },
                  "round": {
                    "divisor": 1,
                    "precision": 1
                  }
                },
                "regexp": {
                  "regexp": "text",
                  "replacement": "text"
                },
                "sqlStatement": {
                  "statement": "text"
                }
              }
            ]
          }
        ],
        "filters": [
          {
            "genericFilter": {
              "conditions": [
                {
                  "condition": "text",
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ]
                }
              ]
            },
            "retentionFilter": {
              "conditions": [
                {
                  "principals": [
                    {
                      "group": "text",
                      "permission": "text",
                      "role": "text"
                    }
                  ],
                  "period": {
                    "days": "text"
                  }
                }
              ],
              "field": {
                "required": true,
                "type": "text",
                "nameParts": [
                  "text"
                ],
                "tags": [
                  "text"
                ]
              }
            }
          }
        ]
      }
    ]
  },
  "violation": {
    "description": "text",
    "field": "text"
  }
}

ListResources

get

/v1alpha/resources

Query parameters

integrationIdstring

A processing platform or data catalog id as configured in your PACE server

resourcePathstring[]

A resource path to list resources under. If empty, the root path is used.

pageParameters.skipinteger · uint32

The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.

pageParameters.pageSizeinteger · uint32

The provided page_size value of the request. If empty, page_size is 10.

pageParameters.pageTokenstring

use this to start from a certain page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha/resources'

200

default

{
  "pageInfo": {
    "nextPageToken": "text",
    "total": 1
  },
  "resources": [
    {
      "catalog": {
        "id": "text",
        "type": "TYPE_UNSPECIFIED",
        "databases": "[Circular Reference]",
        "tags": [
          "text"
        ]
      },
      "integrationFqn": "text",
      "platform": {
        "id": "text",
        "platformType": "PLATFORM_TYPE_UNSPECIFIED"
      },
      "resourcePath": [
        {
          "displayName": "text",
          "isLeaf": true,
          "name": "text",
          "platformName": "text"
        }
      ]
    }
  ]
}