repository

List repositories

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity..
orgIdentifier	string Organization Identifier for the Entity..
projectIdentifier	string Project Identifier for the Entity..
query	string The substring which is used to filter the repositories by their path name.
sort	string Default: "identifier" The data by which the repositories are sorted. Enum: "identifier" "created" "updated"
order	string Default: "asc" The order of the output. Enum: "asc" "desc"
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

Request samples

curl
Java
Go

Response samples

application/json

[{"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"importing": true,
"is_empty": true,
"is_public": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
}
]

Create repository

Securityx-api-key

Request

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

default_branch	string
description	string
fork_id	integer
git_ignore	string
identifier	string
is_public	boolean
license	string
parent_ref	string
readme	boolean
uid	string Deprecated

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/code/api/v1/repos

Request samples

Payload
curl
Java
Go

application/json

{"default_branch": "string",
"description": "string",
"fork_id": 0,
"git_ignore": "string",
"identifier": "string",
"is_public": true,
"license": "string",
"parent_ref": "string",
"readme": true,
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"importing": true,
"is_empty": true,
"is_public": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
}

Soft delete repository

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..

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"deleted_at": 0
}

Get repository

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..

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

{"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"importing": true,
"is_empty": true,
"is_public": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
}

Update repository

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 or null

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

Payload
curl
Java
Go

application/json

{"description": "string"
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"importing": true,
"is_empty": true,
"is_public": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
}

Download repo in archived format

Securityx-api-key

Request

path Parameters

repo_identifier required	string
git_ref required	string
format 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..
path	Array of strings Without an optional path parameter, all files and subdirectories of the current working directory are included in the archive. If one or more paths are specified, only these are included.
prefix	string Prepend / to paths in the archive.
attributes	string Look for attributes in .gitattributes files in the working tree as well
time	string Set modification time of archive entries. Without this option the committer time is used if is a commit or tag, and the current time if it is a tree.
compression	integer Specify compression level. Larger values allow the command to spend more time to compress to smaller size.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/archive/{git_ref}.{format}

Request samples

curl
Java
Go

Response samples

application/json

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

Get git blame

Securityx-api-key

Request

path Parameters

repo_identifier required	string
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..
git_ref	string Default: "{Repository Default Branch}" The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used.
line_from	integer Default: 0 Line number from which the file data is considered
line_to	integer Default: 0 Line number to which the file data is considered

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/blame/{path}

Request samples

curl
Java
Go

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"
},
"file_stats": [{ }
],
"message": "string",
"parent_shas": ["string"
],
"sha": "string",
"title": "string"
},
"lines": ["string"
]
}
]

List branches

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..
include_commit	boolean Default: false Indicates whether optional commit information should be included in the response.
query	string The substring by which the branches are filtered.
order	string Default: "asc" The order of the output. Enum: "asc" "desc"
sort	string Default: "name" The data by which the branches are sorted. Enum: "name" "date"
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}/branches

Request samples

curl
Java
Go

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"
},
"name": "string",
"sha": "string"
}
]

Create branch

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

bypass_rules	boolean
name	string
target	string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable Entity

500

Internal Server Error

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

Request samples

Payload
curl
Java
Go

application/json

{"bypass_rules": true,
"name": "string",
"target": "string"
}

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"
},
"name": "string",
"sha": "string"
}

Delete branch

Securityx-api-key

Request

path Parameters

repo_identifier required	string
branch_name 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..
bypass_rules	boolean Default: false Bypass rule violations if possible.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/branches/{branch_name}

Request samples

curl
Java
Go

Response samples

application/json

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

Get branch

Securityx-api-key

Request

path Parameters

repo_identifier required	string
branch_name 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

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/branches/{branch_name}

Request samples

curl
Java
Go

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"
},
"name": "string",
"sha": "string"
}

Validate code owners file

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..
git_ref	string Default: "{Repository Default Branch}" The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/codeowners/validate

Request samples

curl
Java
Go

Response samples

application/json

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

List commits

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..
git_ref	string Default: "{Repository Default Branch}" The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used.
after	string The result should only contain commits that occurred after the provided reference.
path	string Default: "" Path for which commit information should be retrieved
since	integer Epoch since when commit information should be retrieved.
until	integer Epoch until when commit information should be retrieved.
committer	string Committer pattern for which commit information should be retrieved.
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.
include_stats	boolean Default: false Indicates whether optional stats should be included in the response.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

[{"commits": [{"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"
}
],
"rename_details": [{"commit_sha_after": "string",
"commit_sha_before": "string",
"new_path": "string",
"old_path": "string"
}
],
"total_commits": 0
}
]

Commit files

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

	Array of objects or null (RepoCommitFileAction)
branch	string
bypass_rules	boolean
dry_run_rules	boolean
message	string
new_branch	string
title	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

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

Request samples

Payload
curl
Java
Go

application/json

{"actions": [{"action": "CREATE",
"encoding": "base64",
"path": "string",
"payload": "string",
"sha": "string"
}
],
"branch": "string",
"bypass_rules": true,
"dry_run_rules": true,
"message": "string",
"new_branch": "string",
"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
]
}
]
}
]
}

Get commit

Securityx-api-key

Request

path Parameters

repo_identifier required	string
commit_sha 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

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/commits/{commit_sha}

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 raw git diff of a commit

Securityx-api-key

Request

path Parameters

repo_identifier required	string
commit_sha 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

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/commits/{commit_sha}/diff

Request samples

curl
Java
Go

Response samples

application/json

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

Get commit divergence

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

max_count	integer
	Array of objects or null (RepoCommitDivergenceRequest)

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/commits/calculate-divergence

Request samples

Payload
curl
Java
Go

application/json

{"max_count": 0,
"requests": [{"from": "string",
"to": "string"
}
]
}

Response samples

application/json

[{"ahead": 0,
"behind": 0
}
]

Get content of a file

Securityx-api-key

Request

path Parameters

repo_identifier required	string
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..
git_ref	string Default: "{Repository Default Branch}" The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used.
include_commit	boolean Default: false Indicates whether optional commit information should be included in the response.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/content/{path}

Request samples

curl
Java
Go

Response samples

application/json

{"content": {"data": "string",
"data_size": 0,
"encoding": "base64",
"size": 0
},
"latest_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"
},
"name": "string",
"path": "string",
"sha": "string",
"type": "file"
}

Get diff stats

Securityx-api-key

Request

path Parameters

repo_identifier required	string
range required	string Example: main..dev

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

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/diff-stats/{range}

Request samples

curl
Java
Go

Response samples

application/json

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

Get raw diff

Securityx-api-key

Request

path Parameters

repo_identifier required	string
range required	string Example: main..dev

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

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/diff/{range}

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 raw diff

Securityx-api-key

Request

path Parameters

repo_identifier required	string
range required	string Example: main..dev

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

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/diff/{range}

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

Check mergeability

Securityx-api-key

Request

path Parameters

repo_identifier required	string
range required	string Example: main..dev

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

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/merge-check/{range}

Request samples

curl
Java
Go

Response samples

application/json

{"conflict_files": ["string"
],
"mergeable": true
}

Move repository

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

identifier	string or null
uid	string or null Deprecated

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

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

Request samples

Payload
curl
Java
Go

application/json

{"identifier": "string",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"importing": true,
"is_empty": true,
"is_public": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
}

Get commit details

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..
git_ref	string Default: "{Repository Default Branch}" The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used.

Request Body schema: application/json

paths

Array of strings or null

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/path-details

Request samples

Payload
curl
Java
Go

application/json

{"paths": ["string"
]
}

Response samples

application/json

{"details": [{"last_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"
},
"file_stats": [{ }
],
"message": "string",
"parent_shas": ["string"
],
"sha": "string",
"title": "string"
},
"path": "string"
}
]
}

List all paths

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..
git_ref	string Default: "{Repository Default Branch}" The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used.
include_directories	boolean Default: false Indicates whether directories should be included in the response.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

{"directories": ["string"
],
"files": ["string"
]
}

Purge repository

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..
deleted_at required	integer The exact time the resource was delete at in epoch format.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

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

Get raw file content

Securityx-api-key

Request

path Parameters

repo_identifier required	string
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..
git_ref	string Default: "{Repository Default Branch}" The git reference (branch / tag / commitID) that will be used to retrieve the data. If no value is provided the default branch of the repository is used.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/raw/{path}

Request samples

curl
Java
Go

Response samples

application/json

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

Restore repository

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..
deleted_at required	integer The exact time the resource was delete at in epoch format.

Request Body schema: application/json

new_identifier	string or null
new_parent_ref	string or null

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

Payload
curl
Java
Go

application/json

{"new_identifier": "string",
"new_parent_ref": "string"
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"importing": true,
"is_empty": true,
"is_public": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
}

List protection rules

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..
query	string The substring by which the repository protection rules are filtered.
order	string Default: "asc" The order of the output. Enum: "asc" "desc"
sort	string Default: "created_at" The field by which the protection rules are sorted. Enum: "created_at" "identifier" "uid" "updated_at"
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}/rules

Request samples

curl
Java
Go

Response samples

application/json

[{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"delete_branch": true,
"strategies_allowed": ["merge"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"updated": 0,
"users": {"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
}
}
}
]

Add protection rule

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

	ProtectionBranch (object) (OpenapiRuleDefinition)
description	string
identifier	string
	object or null (ProtectionPattern)
state	string or null (EnumRuleState) Enum: "active" "disabled" "monitor"
type	string (OpenapiRuleType) Value: "branch"
uid	string Deprecated

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

Payload
curl
Java
Go

application/json

{"definition": {"bypass": {"repo_owners": true,
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"delete_branch": true,
"strategies_allowed": ["merge"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"delete_branch": true,
"strategies_allowed": ["merge"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"updated": 0,
"users": {"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
}
}
}

Delete protection rule

Securityx-api-key

Request

path Parameters

repo_identifier required	string
rule_uid 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

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/rules/{rule_uid}

Request samples

curl
Java
Go

Response samples

application/json

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

Get protection rule

Securityx-api-key

Request

path Parameters

repo_identifier required	string
rule_uid 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

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/rules/{rule_uid}

Request samples

curl
Java
Go

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"delete_branch": true,
"strategies_allowed": ["merge"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"updated": 0,
"users": {"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
}
}
}

Update protection rule

Securityx-api-key

Request

path Parameters

repo_identifier required	string
rule_uid 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

	ProtectionBranch (object) (OpenapiRuleDefinition)
description	string or null
identifier	string or null
	object or null (ProtectionPattern)
state	string or null (EnumRuleState) Enum: "active" "disabled" "monitor"
type	string (OpenapiRuleType) Value: "branch"
uid	string or null Deprecated

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/rules/{rule_uid}

Request samples

Payload
curl
Java
Go

application/json

{"definition": {"bypass": {"repo_owners": true,
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"delete_branch": true,
"strategies_allowed": ["merge"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"delete_branch": true,
"strategies_allowed": ["merge"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"updated": 0,
"users": {"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
}
}
}

Get general settings

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..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/settings/general

Request samples

curl
Java
Go

Response samples

application/json

{"file_size_limit": 0
}

Update general settings

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

file_size_limit

integer or null

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/settings/general

Request samples

Payload
curl
Java
Go

application/json

{"file_size_limit": 0
}

Response samples

application/json

{"file_size_limit": 0
}

Get security settings

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..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/settings/security

Request samples

curl
Java
Go

Response samples

application/json

{"secret_scanning_enabled": true,
"vulnerability_scanning_mode": "disabled"
}

Update security settings

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

secret_scanning_enabled	boolean or null
vulnerability_scanning_mode	string or null (SettingsVulnerabilityScanningMode) Enum: "disabled" "detect" "block"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/settings/security

Request samples

Payload
curl
Java
Go

application/json

{"secret_scanning_enabled": true,
"vulnerability_scanning_mode": "disabled"
}

Response samples

application/json

{"secret_scanning_enabled": true,
"vulnerability_scanning_mode": "disabled"
}

Get repository summary

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..

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

{"branch_count": 0,
"default_branch_commit_count": 0,
"pull_req_summary": {"closed_count": 0,
"merged_count": 0,
"open_count": 0
},
"tag_count": 0
}

Create tag

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

bypass_rules	boolean
message	string
name	string
target	string

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}/tags

Request samples

Payload
curl
Java
Go

application/json

{"bypass_rules": true,
"message": "string",
"name": "string",
"target": "string"
}

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"
},
"is_annotated": true,
"message": "string",
"name": "string",
"sha": "string",
"tagger": {"identity": {"email": "string",
"name": "string"
},
"when": "2019-08-24T14:15:22Z"
},
"title": "string"
}

Delete tag

Securityx-api-key

Request

path Parameters

repo_identifier required	string
tag_name 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..
bypass_rules	boolean Default: false Bypass rule violations if possible.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/tags/{tag_name}

Request samples

curl
Java
Go

Response samples

application/json

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

Import repository

Securityx-api-key

Request

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
identifier	string
parent_ref	string
pipelines	string (ImporterPipelineOption) Enum: "convert" "ignore"
	object (ImporterProvider)
provider_repo	string
uid	string Deprecated

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/code/api/v1/repos/import

Request samples

Payload
curl
Java
Go

application/json

{"description": "string",
"identifier": "string",
"parent_ref": "string",
"pipelines": "convert",
"provider": {"host": "string",
"password": "string",
"type": "github",
"username": "string"
},
"provider_repo": "string",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"importing": true,
"is_empty": true,
"is_public": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
}

➔ Next to status_checks