Skip to main content
POST
Queue an HTTPS source capture

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}$

Path Parameters

document
string<uuid>
required

Document.

Body

application/json

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

expected_record_version
integer
required

Validation: required|integer|min:1.

Required range: x >= 1
url
string<uri>

Validation: required|string|max:2048.

Maximum string length: 2048
Pattern: ^https://

Response

Queue an HTTPS source capture response.

data
object