Hex Data Connections API is one of 9 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 API documentation.
This API exposes
5 operations
across 3 paths,
and defines 42 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://app.hex.tech/api.
5 operations3 paths42 schemas2 GET2 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
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}
GetDataConnection1 param→ 200400403500
PATCH
/v1/data-connections/{dataConnectionId}
EditDataConnection1 parambody→ 201400403404422500
GET
/v1/data-connections
ListDataConnections5 params→ 200400403500
POST
/v1/data-connections
CreateDataConnectionbody→ 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…
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are DataConnectionWithSensitiveFieldsApiResource (12 properties), SchemaRefreshScheduleApiResource (6 properties), DataConnectionApiResource (4 properties), UpdateSchemaObjectErrorDetail (4 properties). Each schema is shown below with its type and property counts.
TimezoneDesignator
string
An ISO 8601 timezone designator like +08:00.
EnumValues_typeofSortDirectionEnum_
string
SchemaEntityFilter
object
2 properties
SchemaRefreshScheduleApiResource
object
6 properties2 required
ListDataConnectionsSortByEnum
EnumValues_typeofDataConnectionApiType_
string
EnumValues_typeofDayOfWeekApiEnum_
string
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
DataConnectionWithSensitiveFieldsApiResource
object
12 properties9 required
DataConnectionSchemaRefreshAccess
Omit_TsoaErrorResponsePayload.details_
Construct a type with the properties of T except for those in type K.
EnumValues_typeofScheduleCadenceApiEnum_
string
DayOfWeekApiEnum
DataConnectionSharingAccessLevelEnum
ReadableConnectionDetails
UpdateSchemaObjectErrorDetail
object
Details about a failed update
4 properties3 required
SchemaObjectUpdate
object
Schema object update request - specifies a status change for a database, schema, or table. Currently, only status updates are supported.
3 properties3 required
GroupId
string
Unique ID for a group. This can be found from the groups page (in Settings).
ListDataConnectionsResponse
object
2 properties2 required
TsoaErrorResponsePayload
object
3 properties1 required
EditConnectionDetails
ApiPaginationCursor
string
A cursor string used with before and after parameters to paginate through a list of items on the API.
UpdateDataConnectionSchemaResponse
object
Response body for successful schema object status updates
