Skip to main content
POST
publishArtifact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Input for publishing a TenantArtifact as a TenantConnectorTap. The artifact must be READY with a non-null dataSchema. Publish creates a fresh TenantConnectorTap whose outputSchema is a snapshot copy of artifact.dataSchema at publish time; the two diverge thereafter. Optional name overrides the auto-derived {slug(filename)}-{first 8 hex of artifactId} default; on a unique-index collision the request returns NAME_ALREADY_EXISTS. tableName becomes the dataset/table identifier in the data catalog and is used by the query layer when querying the published data. It is also stored as the artifact catalogSlug / table identity on the published ARTIFACT tap.

artifactId
string
required

UUID v4 with automatic base62 encoding for client-facing APIs

tableName
string
required

A URL friendly version of a string

description
string | null
name
string | null

An objects name

Response

Successful response

data
object
required

Per-workspace tap configuration. Either narrows a platform ConnectorTap's output schema for this workspace (override case) or stands in for an artifact-derived tap (artifact case). See EDR-0021 for the model.

meta
object
required