How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.0, 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.2.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}
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.

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

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
Where this information came from

This is an independent, third-party profile of Hex Data Connections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.