Skip to main content
POST
Authorize an immutable Library source upload

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Headers

Idempotency-Key
string
required

Request key; replay the same key only with the same payload.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

document
object
required
original_file_name
string
required

Validation: required|string|min:1|max:512.

Required string length: 1 - 512
file_extension
string
required

Validation: required|string|min:1|max:32.

Required string length: 1 - 32
Pattern: ^[A-Za-z0-9][A-Za-z0-9._+-]*$
declared_size_bytes
integer
required

Validation: required|integer|min:1|max:9007199254740991.

Required range: 1 <= x <= 9007199254740991
intended_document_type
string
required

Validation: required|string|min:1|max:128.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$
sensitivity_class
string
required

Validation: required|string|min:1|max:128.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

Response

Authorize an immutable Library source upload response.

contract_family
enum<string>
required
Available options:
workspace-blob-admission.v1
contract_version
enum<string>
required
Available options:
workspace-blob-admission-result.v1
outcome
enum<string>
required
Available options:
upload_authorized
admission
object
required
document
object
required
upload_session
object
required
admission_policy_sha256
string
required
Pattern: ^[a-f0-9]{64}$
idempotency_key_sha256
string
required
Pattern: ^[a-f0-9]{64}$
request_sha256
string
required
Pattern: ^[a-f0-9]{64}$
result_sha256
string
required
Pattern: ^[a-f0-9]{64}$
recorded_at
string<date-time>
required