List database connections
Returns a list of available database connections, which you can use to register Database assets.
This API only returns the connections that have already been synchronized with the catalog. If a specific database connection is missing, the /databaseConnections/refresh API can be called to refresh the database connections available in the catalog with the data source.
Request
- Base URL/rest/2.0 (relative, and the document’s source URL is not known)
- Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2Client credentialsToken URL/rest/oauth/v2/tokenScopessys.admin
- or OAuth 2Client credentialsToken URL/rest/oauth/v2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The ID of the Edge connection.
The ID of the schema connection.
The index of the first result to retrieve.
If not set (offset = 0), results will be retrieved starting from row 0.
This is the maximum number of results that may be returned. Fewer may be returned than the value of <code>limit</code>.
Do not depend on the number of results being fewer than the <code>limit</code> value to indicate that your query reached the end of the list of data, use the absence of <code>after</code> (see Cursors) instead. For example, if you set <code>limit</code> to 10 and 9 results are returned, there may be more data available.
If not set, the default limit (limit = <code>25</code>) will be used. The maximum value for this parameter is <code>500</code>.
Response
Database connections successfully retrieved.
Changes
No recorded changes to this operation across all 1 revision of this API.