Skip to main content
PATCH
/
v1
/
repos
/
{id}
/
instructions
/
review
Update repository review instructions
curl --request PATCH \
  --url https://api.ghostsecurity.ai/v1/repos/{id}/instructions/review \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "instructions": "<string>"
}'
{
  "created_at": "2025-05-29T22:27:39.047356Z",
  "enabled": true,
  "instructions": "Focus on security vulnerabilities and follow OWASP guidelines.",
  "updated_at": "2025-05-29T22:27:39.047356Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Repository ID

Body

application/json

Review instructions data

Repository review instructions update request

enabled
boolean

Whether the instructions are enabled

instructions
string

Custom instructions for code reviews (max 2500 characters)

Maximum length: 2500

Response

OK

Repository review instructions

created_at
string

When the instructions were created

Example:

"2025-05-29T22:27:39.047356Z"

enabled
boolean

Whether the instructions are enabled

Example:

true

instructions
string

Custom instructions for code reviews

Example:

"Focus on security vulnerabilities and follow OWASP guidelines."

updated_at
string

When the instructions were last updated

Example:

"2025-05-29T22:27:39.047356Z"

I