status_checks

List status check results

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..
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.
query	string The substring which is used to filter the status checks by their UID.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

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

Report status check results

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

Request Body schema: application/json

check_uid	string Deprecated
ended	integer
identifier	string
link	string
	object (TypesCheckPayload)
started	integer
status	string (EnumCheckStatus) Enum: "error" "failure" "pending" "running" "success"
summary	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

put/code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}

Request samples

Payload
curl
Java
Go

application/json

{"check_uid": "string",
"ended": 0,
"identifier": "string",
"link": "string",
"payload": {"data": null,
"kind": "",
"version": "string"
},
"started": 0,
"status": "error",
"summary": "string"
}

Response samples

application/json

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

List recent status check

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 which is used to filter the status checks by their UID.
since	integer The timestamp (in Unix time millis) since the status checks have been run.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

["string"
]

➔ Next to pullreq