Skip to navigation

Open a bounded delivery lease

Not available on deployed endpoints. Disabled by default; separate activation and delivery permission are required.

Routing misses return an empty 404. Unsupported methods on an exact known path return an empty 405 with Allow, before authentication or body processing.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequiredformat: "uuid"

Canonical lowercase, non-nil UUID of the server-minted passenger session. A locator, not authentication or ownership authority.

Request

Strict UTF-8 JSON without content encoding. At most 16384 actual request bytes including the wrapper; duplicate members, unknown members and depth beyond 16 are refused.

schemaVersionenumRequired
Allowed values:
slotinteger or stringRequired
expectedGenerationstringRequiredformat: "^(0|[1-9][0-9]{0,19})$"
Canonical decimal integer string from 0 through 18446744073709551615, without leading zeros.
openIdstringRequiredformat: "uuid"

Canonical lowercase hyphenated UUID; the nil UUID is valid.

cookieExpiresAtMsinteger or stringRequired
Nonnegative integer Unix milliseconds, within JavaScript's exact integer range.

Response

OK At most 524288 encoded UTF-8 response bytes.

epochobject
expiresAtMsinteger or string
Nonnegative integer Unix milliseconds, within JavaScript's exact integer range.
committedThroughstringformat: "^(0|[1-9][0-9]{0,19})$"
Canonical decimal integer string from 0 through 18446744073709551615, without leading zeros.
acknowledgedThroughstringformat: "^(0|[1-9][0-9]{0,19})$"
Canonical decimal integer string from 0 through 18446744073709551615, without leading zeros.
correlationIdstring
schemaVersionenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
410
Gone Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error