Assign a connection to a product
Use this endpoint to assign an unassigned connection to a product. Provide the target product through the X-Product-Name header. This is a one-time, irreversible operation: once a connection is assigned to a product it cannot be reassigned. Use the List unassigned connections endpoint to find connections that still need a product.
Headers
The authorization token in the Bearer <token> format.
Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.
"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
The product name to assign to this connection. Must contain only alphanumeric characters, underscores, and hyphens (max 100 characters). The value is normalized to lowercase.
100^[a-zA-Z0-9_-]+$"my-product"
Path Parameters
Unique identifier of the connection (UUID format).
"019996b8-f3d1-7d2b-a192-6e91464d82fc"
Response
The connection after it was assigned to the product.
Response object containing connection details.
Unique identifier of the connection (UUID format).
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Unique identifier name for this connection configuration.
"production-db"
Database engine type. Supported values: ORACLE, SQL_SERVER, POSTGRESQL, MONGODB, MYSQL. Note that the data source type field in the List Data Sources endpoint returns lowercase identifiers (postgresql, mongodb).
ORACLE, SQL_SERVER, POSTGRESQL, MONGODB, MYSQL "POSTGRESQL"
Hostname or IP address of the database server.
"db.example.com"
Network port number for the database connection.
5432
Name of the database to connect to on the target server.
"mydatabase"
Username credential for database authentication.
"dbuser"
ISO 8601 timestamp indicating when the connection was created.
"2024-01-15T10:30:00Z"
The product name associated with this connection. May be empty if the connection has not been assigned to a product.
"my-product"
Database schema name, when set.
"public"
SSL configuration returned in connection responses. Only the SSL mode is exposed; certificate material (ca, cert, key) is never returned.
An object containing key-value pairs for storing additional connection-related information. Keys (max 100 characters) and values (max 2000 characters) must be strings. Nested objects are not allowed.
{
"environment": "production",
"team": "data-engineering"
}ISO 8601 timestamp indicating when the connection was last updated.
"2024-01-15T10:30:00Z"

