Skip to main content
POST
Preview effective repository configuration without saving

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Path Parameters

repository_id
string
required
Required string length: 1 - 255

Body

application/json
settings
object
required
org_id
string

Git-provider organization ID. Required for workspace keys; omit for organization keys. This differs from the CodeRabbit organization ID in scope.id.

Minimum string length: 1
enabled
boolean
settings_yaml
Maximum string length: 131072
expected_settings_updated_at

Response

OK

complete
any
required
Available options:
true
yaml
string
required