Get repository review instructions

GET

repos

{id}

instructions

review

Get repository review instructions

curl --request GET \
  --url https://api.ghostsecurity.ai/v2/repos/{id}/instructions/review \
  --header 'Authorization: Bearer <token>'

{
  "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

string

required

Repository ID

Response

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"

Update repository review instructionsUpdate custom instructions for code reviews on pull requests

⌘I

Get repository review instructions

curl --request GET \
  --url https://api.ghostsecurity.ai/v2/repos/{id}/instructions/review \
  --header 'Authorization: Bearer <token>'

{
  "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"
}

Documentation Index

Authorizations

Path Parameters

Response