Skip to main content
POST
/
organizations
/
{organization}
/
databases
/
{database}
/
deploy-requests
/
{number}
/
reviews
Review a deploy request
curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "commented",
  "body": "<string>"
}
'
{
  "id": "<string>",
  "body": "<string>",
  "html_body": "<string>",
  "state": "commented",
  "created_at": "<string>",
  "updated_at": "<string>",
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization
string
required

The name of the organization the deploy request belongs to

​
database
string
required

The name of the database the deploy request belongs to

​
number
integer
required

The number of the deploy request

Body

application/json
​
state
enum<string>

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

Available options:
commented,
approved
​
body
string

Deploy request review comments

Response

Returns the created deploy request review

​
id
string
required

The ID of the review

​
body
string
required

The text body of the review

​
html_body
string
required

The HTML body of the review

​
state
enum<string>
required

Whether the review is a comment or approval

Available options:
commented,
approved
​
created_at
string
required

When the review was created

​
updated_at
string
required

When the review was last updated

​
actor
object
required