Preview a Security finding ticket
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id}/ticket-preview \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id}/ticket-preview"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id}/ticket-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"title": "<string>",
"metadata": [
{
"label": "<string>",
"value": "<string>",
"markdown": "<string>"
}
],
"description": "<string>",
"suggestedPriority": "high",
"defaultStatus": "<string>",
"optionDestination": "jira",
"optionTargetRef": "<string>",
"projectLabel": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Preview a Security finding ticket
Returns the generated ticket content and the existing Jira or Linear destination for a Deep Scan finding. Does not create a ticket. Requires security:read.
GET
/
v1
/
security
/
repositories
/
{repository_id}
/
findings
/
{finding_id}
/
ticket-preview
Preview a Security finding ticket
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id}/ticket-preview \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id}/ticket-preview"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id}/ticket-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"title": "<string>",
"metadata": [
{
"label": "<string>",
"value": "<string>",
"markdown": "<string>"
}
],
"description": "<string>",
"suggestedPriority": "high",
"defaultStatus": "<string>",
"optionDestination": "jira",
"optionTargetRef": "<string>",
"projectLabel": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request "/security/repositories/$REPOSITORY_ID/findings/$FINDING_ID/ticket-preview?finding_kind=vulnerability&destination=$DESTINATION"
An agent connected to the CodeRabbit MCP server runs this operation as the
preview_security_finding_ticket tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "preview_security_finding_ticket",
"arguments": {
"repository_id": "<repository_id>",
"finding_id": "<finding_id>",
"finding_kind": "vulnerability",
"destination": "jira"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Path Parameters
Query Parameters
Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.
Minimum string length:
1Response
OK
Was this page helpful?