pullreq

List pull requests

Securityx-api-key

Request

path Parameters

repo_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
state	Array of strings The state of the pull requests to include in the result. Items Enum: "closed" "merged" "open"
source_repo_identifier	string Source repository ref of the pull requests.
source_branch	string Source branch of the pull requests.
target_branch	string Target branch of the pull requests.
query	string The substring by which the pull requests are filtered.
created_by	Array of integers List of principal IDs who created pull requests.
order	string Default: "asc" The order of the output. Enum: "asc" "desc"
sort	string Default: "number" The data by which the pull requests are sorted. Enum: "created" "edited" "merged" "number" "updated"
created_lt	integer >= 0 The result should contain only entries created before this timestamp (unix millis).
created_gt	integer >= 0 The result should contain only entries created after this timestamp (unix millis).
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.
label_id	Array of integers List of label ids used to filter pull requests.
value_id	Array of integers List of label value ids used to filter pull requests.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq

Request samples

curl
Java
Go

Response samples

application/json

[{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"closed": 0,
"created": 0,
"description": "string",
"edited": 0,
"is_draft": true,
"labels": [{"color": "blue",
"id": 0,
"key": "string",
"scope": 0,
"value": "string",
"value_color": "blue",
"value_count": 0,
"value_id": 0
}
],
"merge_base_sha": "string",
"merge_check_status": "string",
"merge_conflicts": ["string"
],
"merge_method": "fast-forward",
"merge_target_sha": "string",
"merged": 0,
"merger": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"number": 0,
"rebase_check_status": "string",
"rebase_conflicts": ["string"
],
"source_branch": "string",
"source_repo_id": 0,
"source_sha": "string",
"state": "closed",
"stats": {"additions": 0,
"commits": 0,
"conversations": 0,
"deletions": 0,
"files_changed": 0,
"unresolved_count": 0
},
"target_branch": "string",
"target_repo_id": 0,
"title": "string",
"updated": 0
}
]

Create pull request

Securityx-api-key

Request

path Parameters

repo_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

description	string
is_draft	boolean
source_branch	string
source_repo_ref	string
target_branch	string
title	string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/pullreq

Request samples

Payload
curl
Java
Go

application/json

{"description": "string",
"is_draft": true,
"source_branch": "string",
"source_repo_ref": "string",
"target_branch": "string",
"title": "string"
}

Response samples

application/json

{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"closed": 0,
"created": 0,
"description": "string",
"edited": 0,
"is_draft": true,
"labels": [{"color": "blue",
"id": 0,
"key": "string",
"scope": 0,
"value": "string",
"value_color": "blue",
"value_count": 0,
"value_id": 0
}
],
"merge_base_sha": "string",
"merge_check_status": "string",
"merge_conflicts": ["string"
],
"merge_method": "fast-forward",
"merge_target_sha": "string",
"merged": 0,
"merger": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"number": 0,
"rebase_check_status": "string",
"rebase_conflicts": ["string"
],
"source_branch": "string",
"source_repo_id": 0,
"source_sha": "string",
"state": "closed",
"stats": {"additions": 0,
"commits": 0,
"conversations": 0,
"deletions": 0,
"files_changed": 0,
"unresolved_count": 0
},
"target_branch": "string",
"target_repo_id": 0,
"title": "string",
"updated": 0
}

Get pull request

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}

Request samples

curl
Java
Go

Response samples

application/json

{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"closed": 0,
"created": 0,
"description": "string",
"edited": 0,
"is_draft": true,
"labels": [{"color": "blue",
"id": 0,
"key": "string",
"scope": 0,
"value": "string",
"value_color": "blue",
"value_count": 0,
"value_id": 0
}
],
"merge_base_sha": "string",
"merge_check_status": "string",
"merge_conflicts": ["string"
],
"merge_method": "fast-forward",
"merge_target_sha": "string",
"merged": 0,
"merger": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"number": 0,
"rebase_check_status": "string",
"rebase_conflicts": ["string"
],
"source_branch": "string",
"source_repo_id": 0,
"source_sha": "string",
"state": "closed",
"stats": {"additions": 0,
"commits": 0,
"conversations": 0,
"deletions": 0,
"files_changed": 0,
"unresolved_count": 0
},
"target_branch": "string",
"target_repo_id": 0,
"title": "string",
"updated": 0
}

Update pull request

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

description	string
title	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}

Request samples

Payload
curl
Java
Go

application/json

{"description": "string",
"title": "string"
}

Response samples

application/json

{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"closed": 0,
"created": 0,
"description": "string",
"edited": 0,
"is_draft": true,
"labels": [{"color": "blue",
"id": 0,
"key": "string",
"scope": 0,
"value": "string",
"value_color": "blue",
"value_count": 0,
"value_id": 0
}
],
"merge_base_sha": "string",
"merge_check_status": "string",
"merge_conflicts": ["string"
],
"merge_method": "fast-forward",
"merge_target_sha": "string",
"merged": 0,
"merger": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"number": 0,
"rebase_check_status": "string",
"rebase_conflicts": ["string"
],
"source_branch": "string",
"source_repo_id": 0,
"source_sha": "string",
"state": "closed",
"stats": {"additions": 0,
"commits": 0,
"conversations": 0,
"deletions": 0,
"files_changed": 0,
"unresolved_count": 0
},
"target_branch": "string",
"target_repo_id": 0,
"title": "string",
"updated": 0
}

List activities

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
kind	Array of strings The kind of the pull request activity to include in the result. Items Enum: "change-comment" "comment" "system"
type	Array of strings The type of the pull request activity to include in the result. Items Enum: "branch-delete" "branch-restore" "branch-update" "code-comment" "comment" "label-modify" "merge" "review-submit" "reviewer-add" "reviewer-delete" "state-change" "title-change"
after	integer >= 0 The result should contain only entries created at and after this timestamp (unix millis).
before	integer >= 0 The result should contain only entries created before this timestamp (unix millis).
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/activities

Request samples

curl
Java
Go

Response samples

application/json

[{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"code_comment": {"line_new": 0,
"line_old": 0,
"merge_base_sha": "string",
"outdated": true,
"path": "string",
"source_sha": "string",
"span_new": 0,
"span_old": 0
},
"created": 0,
"deleted": 0,
"edited": 0,
"id": 0,
"kind": "change-comment",
"mentions": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
},
"metadata": {"mentions": {"ids": [0
]
},
"suggestions": {"applied_check_sum": "string",
"applied_commit_sha": "string",
"check_sums": ["string"
]
}
},
"order": 0,
"parent_id": 0,
"payload": null,
"pullreq_id": 0,
"repo_id": 0,
"resolved": 0,
"resolver": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"sub_order": 0,
"text": "string",
"type": "branch-delete",
"updated": 0
}
]

Restore pull request source branch

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

bypass_rules	boolean
dry_run_rules	boolean

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/branch

Request samples

Payload
curl
Java
Go

application/json

{"bypass_rules": true,
"dry_run_rules": true
}

Response samples

application/json

{"commit": {"author": {"identity": {"email": "string",
"name": "string"
},
"when": "2019-08-24T14:15:22Z"
},
"committer": {"identity": {"email": "string",
"name": "string"
},
"when": "2019-08-24T14:15:22Z"
},
"message": "string",
"parent_shas": ["string"
],
"sha": "string",
"stats": {"files": [{"changes": 0,
"deletions": 0,
"insertions": 0,
"old_path": "string",
"path": "string",
"status": "string"
}
],
"total": {"changes": 0,
"deletions": 0,
"insertions": 0
}
},
"title": "string"
},
"dry_run_rules": true,
"name": "string",
"rule_violations": [{"bypassable": true,
"bypassed": true,
"rule": {"identifier": "string",
"repo_path": "string",
"space_path": "string",
"state": "active",
"type": "string"
},
"violations": [{"code": "string",
"message": "string",
"params": [null
]
}
]
}
],
"sha": "string"
}

Get status checks

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/checks

Request samples

curl
Java
Go

Response samples

application/json

[{"checks": [{"bypassable": true,
"check": {"created": 0,
"ended": 0,
"id": 0,
"identifier": "string",
"link": "string",
"metadata": null,
"payload": {"data": null,
"kind": "",
"version": "string"
},
"reported_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"started": 0,
"status": "error",
"summary": "string",
"updated": 0
},
"required": true
}
],
"commit_sha": "string"
}
]

Get code owners

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/codeowners

Request samples

curl
Java
Go

Response samples

application/json

{"evaluation_entries": [{"line_number": 0,
"owner_evaluations": [{"owner": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"review_decision": "approved",
"review_sha": "string"
}
],
"pattern": "string",
"user_group_owner_evaluations": [{"evaluations": [{"owner": {"created": null,
"display_name": null,
"email": null,
"id": null,
"type": null,
"uid": null,
"updated": null
},
"review_decision": "approved",
"review_sha": "string"
}
],
"id": "string",
"name": "string"
}
]
}
],
"file_sha": "string"
}

Create new pull request comment

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

line_end	integer
line_end_new	boolean
line_start	integer
line_start_new	boolean
parent_id	integer
path	string
source_commit_sha	string
target_commit_sha	string
text	string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments

Request samples

Payload
curl
Java
Go

application/json

{"line_end": 0,
"line_end_new": true,
"line_start": 0,
"line_start_new": true,
"parent_id": 0,
"path": "string",
"source_commit_sha": "string",
"target_commit_sha": "string",
"text": "string"
}

Response samples

application/json

{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"code_comment": {"line_new": 0,
"line_old": 0,
"merge_base_sha": "string",
"outdated": true,
"path": "string",
"source_sha": "string",
"span_new": 0,
"span_old": 0
},
"created": 0,
"deleted": 0,
"edited": 0,
"id": 0,
"kind": "change-comment",
"mentions": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
},
"metadata": {"mentions": {"ids": [0
]
},
"suggestions": {"applied_check_sum": "string",
"applied_commit_sha": "string",
"check_sums": ["string"
]
}
},
"order": 0,
"parent_id": 0,
"payload": null,
"pullreq_id": 0,
"repo_id": 0,
"resolved": 0,
"resolver": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"sub_order": 0,
"text": "string",
"type": "branch-delete",
"updated": 0
}

Delete pull request comment

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer
pullreq_comment_id required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}

Request samples

curl
Java
Go

Response samples

application/json

{"message": "string",
"values": {"property1": null,
"property2": null
}
}

Update pull request comment

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer
pullreq_comment_id required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

text

string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}

Request samples

Payload
curl
Java
Go

application/json

{"text": "string"
}

Response samples

application/json

{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"code_comment": {"line_new": 0,
"line_old": 0,
"merge_base_sha": "string",
"outdated": true,
"path": "string",
"source_sha": "string",
"span_new": 0,
"span_old": 0
},
"created": 0,
"deleted": 0,
"edited": 0,
"id": 0,
"kind": "change-comment",
"mentions": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
},
"metadata": {"mentions": {"ids": [0
]
},
"suggestions": {"applied_check_sum": "string",
"applied_commit_sha": "string",
"check_sums": ["string"
]
}
},
"order": 0,
"parent_id": 0,
"payload": null,
"pullreq_id": 0,
"repo_id": 0,
"resolved": 0,
"resolver": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"sub_order": 0,
"text": "string",
"type": "branch-delete",
"updated": 0
}

Update status of pull request comment

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer
pullreq_comment_id required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

status

string (EnumPullReqCommentStatus)

Enum: "active" "resolved"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

put/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}/status

Request samples

Payload
curl
Java
Go

application/json

{"status": "active"
}

Response samples

application/json

{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"code_comment": {"line_new": 0,
"line_old": 0,
"merge_base_sha": "string",
"outdated": true,
"path": "string",
"source_sha": "string",
"span_new": 0,
"span_old": 0
},
"created": 0,
"deleted": 0,
"edited": 0,
"id": 0,
"kind": "change-comment",
"mentions": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
},
"metadata": {"mentions": {"ids": [0
]
},
"suggestions": {"applied_check_sum": "string",
"applied_commit_sha": "string",
"check_sums": ["string"
]
}
},
"order": 0,
"parent_id": 0,
"payload": null,
"pullreq_id": 0,
"repo_id": 0,
"resolved": 0,
"resolver": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"sub_order": 0,
"text": "string",
"type": "branch-delete",
"updated": 0
}

Apply pull request code comment suggestions

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

bypass_rules	boolean
dry_run_rules	boolean
message	string
	Array of objects or null (PullreqSuggestionReference)
title	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable Entity

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/apply-suggestions

Request samples

Payload
curl
Java
Go

application/json

{"bypass_rules": true,
"dry_run_rules": true,
"message": "string",
"suggestions": [{"check_sum": "string",
"comment_id": 0
}
],
"title": "string"
}

Response samples

application/json

{"commit_id": "string",
"dry_run_rules": true,
"rule_violations": [{"bypassable": true,
"bypassed": true,
"rule": {"identifier": "string",
"repo_path": "string",
"space_path": "string",
"state": "active",
"type": "string"
},
"violations": [{"code": "string",
"message": "string",
"params": [null
]
}
]
}
]
}

List commits

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/commits

Request samples

curl
Java
Go

Response samples

application/json

[{"author": {"identity": {"email": "string",
"name": "string"
},
"when": "2019-08-24T14:15:22Z"
},
"committer": {"identity": {"email": "string",
"name": "string"
},
"when": "2019-08-24T14:15:22Z"
},
"message": "string",
"parent_shas": ["string"
],
"sha": "string",
"stats": {"files": [{"changes": 0,
"deletions": 0,
"insertions": 0,
"old_path": "string",
"path": "string",
"status": "string"
}
],
"total": {"changes": 0,
"deletions": 0,
"insertions": 0
}
},
"title": "string"
}
]

Get file changes

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
path	Array of strings provide path for diff operation

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/diff

Request samples

curl
Java
Go

Response samples

[{"additions": 0,
"changes": 0,
"deletions": 0,
"is_binary": true,
"is_submodule": true,
"old_path": "string",
"old_sha": "string",
"patch": [0
],
"path": "string",
"sha": "string",
"status": "string"
}
]

Get file changes

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

Array

path	string
start_line	integer

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/diff

Request samples

Payload
curl
Java
Go

application/json

[{"path": "string",
"start_line": 0
}
]

Response samples

[{"additions": 0,
"changes": 0,
"deletions": 0,
"is_binary": true,
"is_submodule": true,
"old_path": "string",
"old_sha": "string",
"patch": [0
],
"path": "string",
"sha": "string",
"status": "string"
}
]

List viewed files

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views

Request samples

curl
Java
Go

Response samples

application/json

[{"obsolete": true,
"path": "string",
"sha": "string"
}
]

Mark file as viewed

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

commit_sha	string
path	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

put/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views

Request samples

Payload
curl
Java
Go

application/json

{"commit_sha": "string",
"path": "string"
}

Response samples

application/json

{"obsolete": true,
"path": "string",
"sha": "string"
}

Remove file view

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer
file_path required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views/{file_path}

Request samples

curl
Java
Go

Response samples

application/json

{"message": "string",
"values": {"property1": null,
"property2": null
}
}

Merge

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

bypass_rules	boolean
dry_run	boolean
message	string
method	string (EnumMergeMethod) Enum: "fast-forward" "merge" "rebase" "squash"
source_sha	string
title	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

422

Unprocessable Entity

post/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/merge

Request samples

Payload
curl
Java
Go

application/json

{"bypass_rules": true,
"dry_run": true,
"message": "string",
"method": "fast-forward",
"source_sha": "string",
"title": "string"
}

Response samples

application/json

{"allowed_methods": ["fast-forward"
],
"branch_deleted": true,
"conflict_files": ["string"
],
"dry_run": true,
"mergeable": true,
"minimum_required_approvals_count": 0,
"minimum_required_approvals_count_latest": 0,
"requires_code_owners_approval": true,
"requires_code_owners_approval_latest": true,
"requires_comment_resolution": true,
"requires_no_change_requests": true,
"rule_violations": [{"bypassable": true,
"bypassed": true,
"rule": {"identifier": "string",
"repo_path": "string",
"space_path": "string",
"state": "active",
"type": "string"
},
"violations": [{"code": "string",
"message": "string",
"params": [null
]
}
]
}
],
"sha": "string"
}

Get metadata

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/metadata

Request samples

curl
Java
Go

Response samples

application/json

{"additions": 0,
"commits": 0,
"conversations": 0,
"deletions": 0,
"files_changed": 0,
"unresolved_count": 0
}

List reviewers

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers

Request samples

curl
Java
Go

Response samples

application/json

[{"added_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"created": 0,
"latest_review_id": 0,
"review_decision": "approved",
"reviewer": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"sha": "string",
"type": "assigned",
"updated": 0
}
]

Add reviewer

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

reviewer_id

integer

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

put/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers

Request samples

Payload
curl
Java
Go

application/json

{"reviewer_id": 0
}

Response samples

application/json

{"added_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"created": 0,
"latest_review_id": 0,
"review_decision": "approved",
"reviewer": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"sha": "string",
"type": "assigned",
"updated": 0
}

Remove reviewer

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer
pullreq_reviewer_id required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/{pullreq_reviewer_id}

Request samples

curl
Java
Go

Response samples

application/json

{"message": "string",
"values": {"property1": null,
"property2": null
}
}

Submit review

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

commit_sha	string
decision	string (EnumPullReqReviewDecision) Enum: "approved" "changereq" "pending" "reviewed"

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviews

Request samples

Payload
curl
Java
Go

application/json

{"commit_sha": "string",
"decision": "approved"
}

Response samples

application/json

{"message": "string",
"values": {"property1": null,
"property2": null
}
}

Update state of pull request

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..

Request Body schema: application/json

is_draft	boolean
state	string (EnumPullReqState) Enum: "closed" "merged" "open"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/state

Request samples

Payload
curl
Java
Go

application/json

{"is_draft": true,
"state": "closed"
}

Response samples

application/json

{"author": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"closed": 0,
"created": 0,
"description": "string",
"edited": 0,
"is_draft": true,
"labels": [{"color": "blue",
"id": 0,
"key": "string",
"scope": 0,
"value": "string",
"value_color": "blue",
"value_count": 0,
"value_id": 0
}
],
"merge_base_sha": "string",
"merge_check_status": "string",
"merge_conflicts": ["string"
],
"merge_method": "fast-forward",
"merge_target_sha": "string",
"merged": 0,
"merger": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"number": 0,
"rebase_check_status": "string",
"rebase_conflicts": ["string"
],
"source_branch": "string",
"source_repo_id": 0,
"source_sha": "string",
"state": "closed",
"stats": {"additions": 0,
"commits": 0,
"conversations": 0,
"deletions": 0,
"files_changed": 0,
"unresolved_count": 0
},
"target_branch": "string",
"target_repo_id": 0,
"title": "string",
"updated": 0
}

➔ Next to upload