Skip to main content
POST
Create a share

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
name
string
required
Required string length: 3 - 200
recipient_kind
enum<string>
required
Available options:
tenant,
external
recipient_name
string
required
Required string length: 1 - 200
warehouse
string
required
Pattern: ^[a-z0-9_][a-z0-9_-]{0,127}$
roles
string[]
required
Required array length: 1 - 20 elements
purpose
string
default:""
Maximum string length: 2000
recipient_url
string
default:""
Maximum string length: 500
recipient_contact
string
default:""
Maximum string length: 320
expires_in_days
integer | null
default:90
Required range: 1 <= x <= 730
setup
RemoteSetup · object | null

Set the share up in the recipient tenant now, as the caller there.

Response

Successful Response

share
ShareSummary · object
required
profile
ConnectionProfile · object | null

Everything an Iceberg REST client needs. Shown once.

delivered
boolean
default:false
setup
RemoteSetupResult · object | null