Sign in

v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Get code repository detail

Returns the details of a code repository

get/repositories/code/{code_repo_id}

Path parameters

code_repo_idinteger required

The ID of the code repo

Response

A code repository

idinteger required

The repository's id in Aikido.

namestring required

The name of the code repository.

provider'github' | 'gitlab' | 'gitlab-server' | 'bitbucket' | 'azure_devops' | 'selfscan' required

The place where the code repository is hosted

external_repo_idstring

The id of the repository from the provider.

external_repo_numeric_idinteger

The numeric id of the repository from the provider.

activeboolean

Indicates if this repository is currently active.

branchstring required

The branch set up to scan in the repository.

urlstring

External URL to the repo

last_scanned_atinteger

A timestamp indicating when the repository was last scanned. Value will be -1 if no scan has occurred.

connectivity'connected' | 'not_connected' | 'unknown'

Tells Aikido if this code runs in an internet-connected server.

sensitivity'extreme' | 'sensitive' | 'normal' | 'not_sensitive' | 'no_data'

The sensitivity of the repository.

Example response

{
  "id": 1,
  "name": "Compression service",
  "provider": "github",
  "external_repo_id": "R_kgDOI5RlKA",
  "external_repo_numeric_id": 1234567890,
  "active": true,
  "branch": "main",
  "url": "https://api.github.com/repos/aikidemo/compression-service",
  "last_scanned_at": 1678886400,
  "linked_teams": [
    {
      "id": 1,
      "name": "Backend Team"
    },
    {
      "id": 1,
      "name": "Custom Aikido Team"
    }
  ],
  "excluded_paths": [
    {
      "id": 1,
      "path": "tests/"
    },
    {
      "id": 2,
      "path": "docs/"
    }
  ],
  "connectivity": "connected",
  "sensitivity": "normal",
  "labels": [
    {
      "id": 1,
      "name": "production",
      "is_imported": false
    },
    {
      "id": 2,
      "name": "core",
      "is_imported": true
    }
  ]
}