Skip to main content
Add file
Operation ID: http.files.admit

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

1–200 printable ASCII characters, no surrounding spaces; '.' and '..' are reserved. Reuse this key with the same request when retrying an uncertain outcome.

Required string length: 1 - 200
Pattern: ^(?!\.{1,2}$)[!-~](?:[ -~]*[!-~])?$

Path Parameters

org
string
required
project
string
required

Body

application/json
upload_id
string
required
name
string
required
description
any

Text of at most 4096 bytes, or null.

tags
any

At most 64 strings of 1 to 128 characters.

metadata
any

A JSON object of at most 16 KiB.

external_key
any

1 to 512 characters, or null.

upload_batch_id
any

The upload batch (one drop of files) this File belongs to, from POST …/files/upload-batches. The batch holds the drop's note.

source_date
any

YYYY, YYYY-MM, YYYY-MM-DD or an RFC 3339 date-time with an offset.

Response

2XX - application/json

Success.

request_id
string
required
outcome
string
required
Allowed value: "queued"
replayed
boolean
required
data
object
required
{key}
any