Skip to Content
veriom

Get code scanning

GET
/v1/workspaces/{workspace_id}/repositories/{repository_id}/code-scanning

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
repository_id*Repository Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
available*Available

The repository is on GitHub and connected through Veriom's GitHub App.

default_branch*Default Branch
enabled*Enabled
permission*Permission

Whether the GitHub App installation reported the security_events: write permission. A hint: GitHub decides when Veriom asks for an upload token.

Value in"granted""missing""unknown"
repository_id*Repository Id
Formatuuid
required_permission?Required Permission
Default"security_events: write"
unavailable_reason?|null
uploads*array<>
Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/repositories/497f6eca-6276-4993-bfeb-53cbbbba6f08/code-scanning'
Example Response
{  "available": true,  "default_branch": "string",  "enabled": true,  "permission": "granted",  "repository_id": "b349ae61-b973-4c6c-a5e0-89183ba99ff3",  "required_permission": "security_events: write",  "unavailable_reason": "not_github",  "uploads": [    {      "attempts": 0,      "audit_id": "78c04fa6-cfb4-46a0-9aa5-3681ba4f3897",      "commit_sha": "string",      "completed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "error_code": "string",      "error_detail": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "omitted": {        "property1": 0,        "property2": 0      },      "ref": "string",      "results_count": 0,      "status": "queued",      "uploaded_at": "2019-08-24T14:15:22Z"    }  ]}