Creates a single-use ticket admitting one WebSocket to the note's live room.
A ticket is handed over once and redeemed once, so it has no URL to read it back from.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Note id
Responses
Section titled “Responses”Admission ticket
A single-use ticket admitting one WebSocket connection to a note’s room.
object
The caller’s access level for this connection.
Example
{ "role": "editor"}The request is malformed
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}No valid session token
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The Bearer challenge (RFC 6750).
Note not found
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Too many requests
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”Seconds to wait. Sent when the limit knows when it lifts.
The service failed
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The service is at capacity
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}