v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Deploy requests

Review a deploy request

Review a deploy request by either approving or commenting on the deploy request

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses approve_deploy_request, review_deploy_request

OAuth Scopes

ResourceScopes
Organizationapprove_deploy_requests
Databaseapprove_deploy_requests
post/organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews

Path parameters

organizationstring required

The name of the organization the deploy request belongs to

databasestring required

The name of the database the deploy request belongs to

numberinteger required

The number of the deploy request

Request body

state'commented' | 'approved'

Whether the review is a comment or approval. Service tokens must have corresponding access (either approve_deploy_request or review_deploy_request)

bodystring

Deploy request review comments

Response

Returns the created deploy request review

idstring required

The ID of the review

bodystring required

The text body of the review

html_bodystring required

The HTML body of the review

state'commented' | 'approved' required

Whether the review is a comment or approval

created_atstring required

When the review was created

updated_atstring required

When the review was last updated