Skip to main content
POST
Privately ingest an authorized host file

Authorizations

Authorization
string
header
required

Dedicated expiring guest-session capability. Never a developer API key. No Batch Relay account or Studio membership required.

Headers

X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

session_id
string
required
Maximum string length: 255

Body

application/json
download_url
string
required
file_id
string
required
host
string
required
file_name
string
mime_type
string

Response

Success

The response is of type object.