Data Catalog API methods that are related to Data Catalog search and metadata are deprecated and will be discontinued on January 30, 2026. SeeTransition from Data Catalog to Dataplex Universal Catalog. Methods that are related to policy tags and policy tag taxonomies are not deprecated.
Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.
HTTP request
POST https://datacatalog.googleapis.com/v1/{name}:setConfig
Path parameters
Parameters
name
string
Required. The organization or project whose config is being specified. It takes the formprojects/{project}/locations/{location}.
Request body
The request body contains data with the following structure:
JSON representation
{// Union fieldconfigurationcan be only one of the following:"tagTemplateMigration":enum (TagTemplateMigration),"catalogUiExperience":enum (CatalogUIExperience)// End of list of possible types for union fieldconfiguration.}
Fields
Union fieldconfiguration. The configuration field to set.configurationcan be only one of the following:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-17 UTC."],[[["\u003cp\u003eThis page details the configuration settings for migrating to Dataplex from Data Catalog, which is now deprecated.\u003c/p\u003e\n"],["\u003cp\u003eThe primary function described is setting the configuration for an organization or project via a POST HTTP request to a specific endpoint, \u003ccode\u003ehttps://datacatalog.googleapis.com/v1/{name}:setConfig\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eConfiguration options include setting the opt-in status for Tag Template migration to Dataplex and the UI switch to Dataplex, represented within a union field in the request body.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests return an instance of \u003ccode\u003eMigrationConfig\u003c/code\u003e in the response body, and the authorization for this operation requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope along with the \u003ccode\u003edatacatalog.migrationConfig.set\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.setConfig\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\n| Data Catalog is deprecated. Please use Dataplex Universal Catalog instead.\nSets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.\n\n### HTTP request\n\n`POST https://datacatalog.googleapis.com/v1/{name}:setConfig`\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [MigrationConfig](/data-catalog/docs/reference/rest/v1/MigrationConfig).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `datacatalog.migrationConfig.set`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
