Skip to main content
POST
Create Sidecar Review

Headers

hoop-sidecar-token
string
required

The token returned when the sidecar was created

Body

application/json

The request body resource

approval_rule
string
required

The access request rule that decides who may approve this statement

It must be the rule the sidecar's stored configuration names for this listener. The rule carries the reviewer groups, the approval count and the force-approval list; the sidecar holds none of that policy and only names it.

Bounded at 254 to match what a rule name may be.

Maximum string length: 254
Example:

"payments-approvers"

listener_name
string
required

The sidecar listener the statement arrived on

Bounded because private.reviews.listener_name is VARCHAR(255): a longer name would reach Postgres and fail the write, rather than being told at the door that it is too long.

Maximum string length: 255
Example:

"appdb"

payload
string
required

The statement to review, base64 encoded

Example:

"REVMRVRFIEZST00gdXNlcnM7"

Response

OK

forward
boolean

Whether the sidecar may release the statement it held

True only on the request that consumed an approved review, and only once per review. False while the review waits, and false forever once it is rejected or revoked.

Example:

false

review
object

The review the statement is waiting on, or the one that released it