Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hex Data Connections API

The Data Connections API from Hex — 3 operation(s) for data connections.

Hex Data Connections API is one of 11 APIs that Hex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Connections. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 5 operations across 3 paths, and defines 42 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://app.hex.tech/api.

5 operations 3 paths 42 schemas 2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://app.hex.tech/api/v1
Authentication
HTTP Bearer
License
UNLICENSED
Resource Areas
1

Authentication & Security 1

Hex Data Connections API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Data Connections 5
GET
/v1/data-connections/{dataConnectionId}
GetDataConnection 1 param → 200400403500
PATCH
/v1/data-connections/{dataConnectionId}
EditDataConnection 1 param body → 201400403404422500
GET
/v1/data-connections
ListDataConnections 5 params → 200400403500
POST
/v1/data-connections
CreateDataConnection body → 201400403404422500
PATCH
/v1/data-connections/{dataConnectionId}/schema
Use this endpoint to add or remove a status (including endorsements) from databases, schemas, and tables within a data connection This endpoint uses atomic semantics - if any update in the batch fail…
UpdateDataConnectionSchema 1 param body → 200400403404

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are DataConnectionWithSensitiveFieldsApiResource (12 properties), SchemaRefreshScheduleApiResource (6 properties), UpdateSchemaObjectErrorDetail (4 properties), DataConnectionApiResource (4 properties). Each schema is shown below with its type and property counts.

Pick_TsoaErrorResponsePayload.Exclude_keyofTsoaErrorResponsePayload.details__
object
From T, pick a set of properties whose keys are in the union K
2 properties 1 required
EnumValues_typeofListDataConnectionsSortByEnum_
string
UpdateDataConnectionSchemaResponse
object
Response body for successful schema object status updates
1 property 1 required
TimezoneStringDesignator
string
CreateConnectionDetails
UpdateDataConnectionSchemaRequest
object
Request body for updating data connection schema object statuses Currently, only status updates are supported.
1 property 1 required
ReadableConnectionDetails
PaginationApiResource
object
2 properties 2 required
EnumValues_typeofDataConnectionSchemaRefreshAccess_
string
ListDataConnectionsSortByEnum
SchemaObjectUpdate
object
Schema object update request - specifies a status change for a database, schema, or table. Currently, only status updates are supported.
3 properties 3 required
EnumValues_typeofDayOfWeekApiEnum_
string
SchemaFilterMatchType
TsoaErrorResponsePayload
object
3 properties 1 required
SchemaRefreshScheduleApiResource
object
6 properties 2 required
EnumValues_typeofDataConnectionSharingAccessLevelEnum_
string
PageSize
integer
Number of results to fetch per page for paginated requests
DataConnectionId
string
Unique ID for a data connection.
UpdateSchemaObjectErrorDetail
object
Details about a failed update
4 properties 3 required
DataConnectionSchemaRefreshAccess
EnumValues_typeofDataConnectionApiType_
string
ApiPaginationCursor
string
A cursor string used with before and after parameters to paginate through a list of items on the API.
EnumValues_typeofDataConnectionPublicSharingAccessLevelEnum_
string
SortDirectionEnum
EnumValues_typeofSortDirectionEnum_
string
Name
string
ScheduleCadenceApiEnum
Types of cadence of a schedule for a Hex project.
Omit_TsoaErrorResponsePayload.details_
Construct a type with the properties of T except for those in type K.
DataConnectionApiResource
object
4 properties 3 required
DataConnectionWithSensitiveFieldsApiResource
object
12 properties 9 required
EnumValues_typeofSchemaFilterMatchType_
string
ListDataConnectionsResponse
object
2 properties 2 required
SchemaEntityFilter
object
2 properties
DataConnectionSharingAccessLevelEnum
EnumValues_typeofScheduleCadenceApiEnum_
string
DataConnectionApiType
EditConnectionDetails
DayOfWeekApiEnum
DataConnectionPublicSharingAccessLevelEnum
GroupId
string
Unique ID for a group. This can be found from the groups page (in Settings).
TimezoneDesignator
string
An ISO 8601 timezone designator like +08:00.
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-data-connections-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

Hex Cells API
Hex Collections API
Hex Context API
Hex Embedding API
Hex Groups API
Hex Guides API
Hex Projects API
Hex Semantic (projects|models) API
Hex Threads API
Hex Users API