Repository

Query:repository Fetch the details of one of your repositories.

Arguments

Field	Type	Description
name	String!	The name of the repository to lookup.
login	String!	The login or username of the account under which the repository exists.
vcsProvider	VCSProvider!	VCS Provider of the account.

Sample Request

query {
  repository(
      name:"demo-go",
      login:"cyberdyne",
      vcsProvider:GITHUB
    ) {
    name
    defaultBranch
    dsn
    isPrivate
    analysisRuns {
      edges {
        node {
          runUid
        }
      }
    }
  }
}

Sample Response

{
  "data": {
    "repository": {
      "name": "demo-go",
      "defaultBranch": "master",
      "dsn": "https://[email protected]",
      "isPrivate": true,
      "analysisRuns": {
        "edges": [
          {
            "node": {
              "runUid": "5d821174-04vf-4214-b56d-ced0a7ca209e"
            }
          },
          {
            "node": {
              "runUid": "6ff1cdb8-9abe-4307-a177-4b9f8d3ba639"
            }
          },
        ]
      }
    }
  }
}

SCA Queries

Fetching Repository Targets

Query to list all SCA targets configured for a repository.

query {
  repository(
    name: "my-app",
    login: "myorg",
    vcsProvider: GITHUB
  ) {
    name
    targets {
      edges {
        node {
          id
          ecosystem
          packageManager
          manifestPath
          lockfilePath
          source
          isActivated
        }
      }
    }
  }
}

Sample Response:

{
  "data": {
    "repository": {
      "name": "my-app",
      "targets": {
        "edges": [
          {
            "node": {
              "id": "UmVwb3NpdG9yeVRhcmdldDoxMjM0NQ==",
              "ecosystem": "NPM",
              "packageManager": "NPM",
              "manifestPath": "package.json",
              "lockfilePath": "package-lock.json",
              "source": "AUTO",
              "isActivated": true
            }
          },
          {
            "node": {
              "id": "UmVwb3NpdG9yeVRhcmdldDoxMjM0Ng==",
              "ecosystem": "PYPI",
              "packageManager": "REQUIREMENTS_TXT",
              "manifestPath": "requirements.txt",
              "lockfilePath": "requirements.txt",
              "source": "AUTO",
              "isActivated": true
            }
          }
        ]
      }
    }
  }
}

Fetching Dependency Vulnerabilities

Query to list all dependency vulnerability occurrences in a repository.

query {
  repository(
    name: "my-app",
    login: "myorg",
    vcsProvider: GITHUB
  ) {
    name
    dependencyVulnerabilityOccurrences(first: 10) {
      edges {
        node {
          id
          reachability
          fixability
          vulnerability {
            identifier
            summary
            severity
            cvssV3BaseScore
            cvssV3Severity
            epssScore
            publishedAt
            fixedVersions
            referenceUrls
          }
          package {
            name
            ecosystem
          }
          packageVersion {
            version
          }
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
}

Sample Response:

{
  "data": {
    "repository": {
      "name": "my-app",
      "dependencyVulnerabilityOccurrences": {
        "edges": [
          {
            "node": {
              "id": "VnVsbmVyYWJpbGl0eU9jY3VycmVuY2U6MTIzNDU=",
              "reachability": "REACHABLE",
              "fixability": "AUTO_FIXABLE",
              "vulnerability": {
                "identifier": "CVE-2024-12345",
                "summary": "Critical vulnerability in package XYZ",
                "severity": "CRITICAL",
                "cvssV3BaseScore": 9.8,
                "cvssV3Severity": "CRITICAL",
                "epssScore": 0.95,
                "publishedAt": "2024-01-15T10:30:00Z",
                "fixedVersions": ["1.2.5", "2.0.1"],
                "referenceUrls": [
                  "https://nvd.nist.gov/vuln/detail/CVE-2024-12345",
                  "https://github.com/advisories/GHSA-xxxx-yyyy-zzzz"
                ]
              },
              "package": {
                "name": "vulnerable-package",
                "ecosystem": "NPM"
              },
              "packageVersion": {
                "version": "1.2.3"
              }
            }
          }
        ],
        "pageInfo": {
          "hasNextPage": true,
          "endCursor": "YXJyYXljb25uZWN0aW9uOjE="
        }
      }
    }
  }
}

Fetching a Specific Vulnerability Occurrence

Query to fetch details of a specific vulnerability occurrence by ID.

query {
  repository(
    name: "my-app",
    login: "myorg",
    vcsProvider: GITHUB
  ) {
    dependencyVulnerabilityOccurrence(
      id: "VnVsbmVyYWJpbGl0eU9jY3VycmVuY2U6MTIzNDU="
    ) {
      id
      reachability
      fixability
      vulnerability {
        identifier
        aliases
        summary
        details
        severity
        cvssV3Vector
        cvssV3BaseScore
        introducedVersions
        fixedVersions
        publishedAt
        updatedAt
      }
      package {
        name
        ecosystem
        purl
      }
      packageVersion {
        version
        versionType
      }
    }
  }
}

Sample Response:

{
  "data": {
    "repository": {
      "dependencyVulnerabilityOccurrence": {
        "id": "VnVsbmVyYWJpbGl0eU9jY3VycmVuY2U6MTIzNDU=",
        "reachability": "REACHABLE",
        "fixability": "AUTO_FIXABLE",
        "vulnerability": {
          "identifier": "CVE-2024-12345",
          "aliases": ["GHSA-xxxx-yyyy-zzzz"],
          "summary": "Critical vulnerability in package XYZ",
          "details": "Detailed description of the vulnerability...",
          "severity": "CRITICAL",
          "cvssV3Vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
          "cvssV3BaseScore": 9.8,
          "introducedVersions": ["1.0.0"],
          "fixedVersions": ["1.2.5", "2.0.1"],
          "publishedAt": "2024-01-15T10:30:00Z",
          "updatedAt": "2024-01-20T15:45:00Z"
        },
        "package": {
          "name": "vulnerable-package",
          "ecosystem": "NPM",
          "purl": "pkg:npm/[email protected]"
        },
        "packageVersion": {
          "version": "1.2.3",
          "versionType": "SEMVER"
        }
      }
    }
  }
}

Fetching a Specific Repository Target

Query to fetch details of a specific repository target by ID.

query {
  repository(
    name: "my-app",
    login: "myorg",
    vcsProvider: GITHUB
  ) {
    target(id: "UmVwb3NpdG9yeVRhcmdldDoxMjM0NQ==") {
      id
      ecosystem
      packageManager
      manifestPath
      lockfilePath
      source
      isActivated
    }
  }
}

Sample Response:

{
  "data": {
    "repository": {
      "target": {
        "id": "UmVwb3NpdG9yeVRhcmdldDoxMjM0NQ==",
        "ecosystem": "NPM",
        "packageManager": "NPM",
        "manifestPath": "package.json",
        "lockfilePath": "package-lock.json",
        "source": "AUTO",
        "isActivated": true
      }
    }
  }
}

regenerateRepositoryDSN

Mutation:regenerateRepositoryDSN Regenerate a repository’s DSN.

Arguments

Field	Type	Description
input	RegenerateRepositoryDSNInput!	Input for `RegenerateRepositoryDSN` mutation.

Sample Request

mutation ($input: RegenerateRepositoryDSNInput!) {
  regenerateRepositoryDSN(input: $input) {
    dsn
  }
}

variables = {
  "input": {
    "repositoryId": "VHJhbnNmb3JtZXI6bGp6a3d6"
  }
}

Sample Response

{
  "regenerateRepositoryDSN": {
    "dsn": "https://[email protected]"
  }
}

updateRepositoryDefaultBranch

Mutation:updateRepositoryDefaultBranch Update a repository’s default branch for baseline. If the repository is activated, this action will trigger a new analysis. Only available to users with WRITE permission on the repository.

Arguments

Field	Type	Description
input	UpdateRepositoryDefaultBranchInput!	Input for `UpdateRepositoryDefaultBranch` mutation

Sample Request

mutation ($input: UpdateRepositoryDefaultBranchInput!) {
  updateRepositoryDefaultBranch(input: $input) {
    ok
    repository {
      defaultBranchName
    }
  }
}

variables = {
  "input": {
    "id": "VHJhbnNmb3JtZXI6bGp6a3d6",
    "defaultBranchName": "add-awesomeness"
  }
}

Sample Response

{
  "updateRepositoryDefaultBranch": {
    "ok": true,
    "repository": {"defaultBranchName": "add-awesomeness"}
  }
}

updateRepositoryIssueCategorySetting

Mutation:updateRepositoryIssueCategorySetting Update a repository’s issue configuration (also known as quality gates). Only users with WRITE permission on the repository can trigger this mutation.

Arguments

Field	Type	Description
input	UpdateRepositoryIssueCategorySettingInput!	Input for `UpdateRepositoryIssueCategorySetting` mutation.

Sample Request

mutation ($input: UpdateRepositoryIssueCategorySettingInput!) {
  updateRepositoryIssueCategorySetting(input: $input) {
    ok
  }
}

{
  "input": {
    "repositoryId": "Umwm3NpdG9yeTprZ3dyb222",
		"issueCategory": "ANTI_PATTERN",
    "isReported": true,
    "canFailCheck": false
  }
}

Sample Response

{
  "data": {
    "updateRepositoryIssueCategorySetting": {
      "ok": true
    }
  }
}

updateRepositoryMetricSetting

Mutation:updateRepositoryMetricSetting Update a repository’s metric quality gates configuration. Only users with WRITE permission on the repository can trigger this mutation.

Arguments

Field	Type	Description
input	UpdateRepositoryMetricSettingInput!	Input for `updateRepositoryMetricSetting` mutation.

Sample Request

mutation UpdateRepositoryMetricSetting($input: UpdateRepositoryMetricSettingInput!) {
  updateRepositoryMetricSetting(input: $input) {
    ok
  }
}

{
  "input": {
    "repositoryId": "Umvwb2NpdG9yeTphanZqcGx=",
    "metricShortcode": "LCV",
    "isReported": true,
    "isThresholdEnforced": true
  }
}

Sample Response

{
  "data": {
  	"updateRepositoryMetricSetting": {
  		"ok": true
  	}
  }
}

activateRepository

Mutation:activateRepositoryActivate analysis on a repository. Only users with WRITE permission on the repository can trigger this mutation.

Arguments

Field	Type	Description
input	ActivateRepositoryInput!	Input for `activateRepository` mutation.

Sample Request

mutation ($input: ActivateRepositoryInput!) {
  activateRepository(input: $input) {
    ok
  }
}

{
  "input": {
    "repositoryId": "Umwm3NpdG9yeTprZ3dyb222"
  }
}

Sample Response

{
  "data": {
    "activateRepository": {
      "ok": true
    }
  }
}

deactivateRepository

Mutation:deactivateRepositoryDeactivate analysis on a repository. Only users with WRITE permission on the repository can trigger this mutation.

Arguments

Field	Type	Description
input	DeactivateRepositoryInput!	Input for `deactivateRepository` mutation.

Sample Request

mutation ($input: DeactivateRepositoryInput!) {
  deactivateRepository(input: $input) {
    ok
  }
}

{
  "input": {
    "repositoryId": "Umwm3NpdG9yeTprZ3dyb222"
  }
}

Sample Response

{
  "data": {
    "deactivateRepository": {
      "ok": true
    }
  }
}

Objects

Repository

Field	Type	Description
id	ID!	The ID of the object.
name	String!	The name of this repository.
vcsProvider	VCSProvider!	VCS Provider of the repository.
vcsUrl	String!	URL of the repository on the VCS.
latestCommitOid	String	Object ID of the latest commit on the default branch.
isPrivate	Boolean!	Repository visibility on the VCS provider.
isActivated	Boolean!	Repository activation status.
configJson	JSON	The `.deepsource.toml` config of the repository represented as a JSON object.
defaultBranch	String	The default base branch of the repository on DeepSource.
dsn	String	The DSN value for this repository.
account	Account!	The account under which this repository exists.
analysisRuns	AnalysisRunConnection	Past analysis runs for the repository
offset	Int
before	String
after	String
first	Int
last	Int
enabledAnalyzers	AnalyzerConnection	The analyzers enabled in this repository.
offset	Int
before	String
after	String
first	Int
last	Int
issues	RepositoryIssueConnection	Get all issues raised in the default branch of this repository. Specifying a path would only return those issues whose occurrences are present in the file at path.
path	String	Show issues for this path only.
offset	Int
before	String
after	String
first	Int
last	Int
ignoreRules	IgnoreRuleConnection	List of `IgnoreRule`s that exist for the repository.
issueShortcode	String	Filter by an `Issue` shortcode.
filePath	String	Filter by a specific file’s path.
offset	Int
before	String
after	String
first	Int
last	Int
dependencyVulnerabilityOccurrences	VulnerabilityOccurrenceConnection	List of dependency vulnerability occurrences in the default branch.
offset	Int
before	String
after	String
first	Int
last	Int
dependencyVulnerabilityOccurrence	VulnerabilityOccurrence!	Get a dependency vulnerability occurrence by its ID.
id	ID!	The ID of the vulnerability occurrence.
target	RepositoryTarget!	Get a specific repository target.
id	ID!	The ID of the repository target.
targets	RepositoryTargetConnection!	List of repository targets for this repository.
offset	Int
before	String
after	String
first	Int
last	Int
report	Report!	A report associated with this repository.
key	ReportKey!	The key of the report to fetch.
metrics	[RepositoryMetric!]!	List of all DeepSource metrics.
shortcodeIn	[MetricShortcode]	List of metric shortcodes to filter on.
issueCategorySettings	[IssueCategorySetting!]!	Issue categories quality gates configuration for the repository.
issuePrioritySettings	[IssuePrioritySetting!]!	Issue priority quality gates configuration for the repository.
metricSettings	[MetricSetting!]!	Metric quality gates configuration for the repository.
allowAutofixAi	Boolean!	Whether the account has allowed Autofix AI to run on private repositories.
useLegacyAutofix	Boolean!	Whether to use the legacy autofix engine.

RepositoryIssue

Field	Type	Description
id	ID!	The ID of the object.
issue	Issue!	Definition of the issue that has been raised.
occurrences	OccurrenceConnection	All occurrences of this issue in the default branch.
offset	Int
before	String
after	String
first	Int
last	Int
repository	Repository!	The repository for which this issue has been raised.

RepositoryIssueConnection

Field	Type	Description
pageInfo	PageInfo!	Pagination data for this connection.
edges	RepositoryIssueEdge!	Contains the nodes in this connection.
totalCount	Int

RepositoryIssueEdge

A Relay edge containing a RepositoryIssue and its cursor.

Field	Type	Description
node	RepositoryIssue	The item at the end of the edge.
cursor	String!	A cursor for use in pagination.

RepositoryConnection

Field	Type	Description
pageInfo	PageInfo!	Pagination data for this connection.
edges	[RepositoryEdge]!	Contains the nodes in this connection.
totalCount	Int

RepositoryEdge

A Relay edge containing a Repository and its cursor.

Field	Type	Description
node	Repository	The item at the end of the edge.
cursor	String!	A cursor for use in pagination.

RegenerateRepositoryDSNInput

Input for the regenerateRepositoryDSN mutation.

Field	Type	Description
repositoryId	ID!	GraphQL node ID of the repository.

RegenerateRepositoryDSNPayload

Payload for the regenerateRepositoryDSN mutation.

Field	Type	Description
dsn	String!	The new DSN for the repository.

UpdateRepositoryDefaultBranchInput

Input for the updateRepositoryDefaultBranch mutation.

Field	Type	Description
id	ID!	GraphQL node ID of the repository.
defaultBranchName	String!	Default branch for analysis on the repository.

UpdateRepositoryDefaultBranchPayload

Payload for the updateRepositoryDefaultBranch mutation.

Field	Type	Description
ok	Boolean!	Whether the operation was successful.
repository	Repository!	`Repository` type.

UpdateRepositoryIssueCategorySettingInput

Input for the updateRepositoryIssueCategorySetting mutation.

Field	Type	Description
repositoryId	ID!	The repository’s ID.
issueCategory	IssueCategory!	The issue category you want to update.
isReported	Boolean!	Whether issues of a given category are enabled for reporting in the repository.
canFailCheck	Boolean!	Whether to fail checks when occurrence(s) of issues of a given category is found in the repository, an issue category can only be marked to fail a check if it is enabled for reporting.

UpdateRepositoryIssueCategorySettingPayload

Paylod for the updateRepositoryIssueCategorySetting mutation.

Field	Type	Description
ok	Boolean!	Whether the operation was successful.

UpdateRepositoryMetricSettingInput

Input for the updateRepositoryMetricSetting mutation.

Field	Type	Description
repositoryId	ID!	The repository’s ID.
metricShortcode	MetricShortcode!	The shortcode of the metric you want to update.
isReported	Boolean!	Whether the metric is enabled for reporting in the repository.
isThresholdEnforced	Boolean!	Whether to fail checks when the metric does not meet the threshold.

UpdateRepositoryMetricSettingPayload

Payload for the updateRepositoryMetricSetting mutation.

Field	Type	Description
ok	Boolean!	Whether the operation was successful.

ActivateRepositoryInput

Input for the activateRepository mutation.

Field	Type	Description
repositoryId	ID!	GraphQL node ID of the repository.

ActivateRepositoryPayload

Payload for the activateRepository mutation.

Field	Type	Description
ok	Boolean!	Whether the operation was successful.

DeactivateRepositoryInput

Input for the deactivateRepository mutation.

Field	Type	Description
repositoryId	ID!	GraphQL node ID of the repository.

DeactivateRepositoryPayload

Payload for the deactivateRepository mutation.

Field	Type	Description
ok	Boolean!	Whether the operation was successful.

VulnerabilityOccurrence

Represents an occurrence of a vulnerability in a specific package version within a repository.

Field	Type	Description
id	ID!	The ID of the object.
reachability	VulnerabilityOccurrenceReachability!	The reachability of the vulnerability occurrence.
fixability	VulnerabilityOccurrenceFixability!	The fixability of the vulnerability occurrence.
vulnerability	Vulnerability!	The vulnerability details.
package	Package!	The package associated with the vulnerability occurrence.
packageVersion	PackageVersion!	The package version associated with the vulnerability occurrence.

VulnerabilityOccurrenceConnection

Field	Type	Description
pageInfo	PageInfo!	Pagination data for this connection.
edges	[VulnerabilityOccurrenceEdge]!	Contains the nodes in this connection.
totalCount	Int

VulnerabilityOccurrenceEdge

A Relay edge containing a VulnerabilityOccurrence and its cursor.

Field	Type	Description
node	VulnerabilityOccurrence	The item at the end of the edge.
cursor	String!	A cursor for use in pagination.

Vulnerability

Details about a security vulnerability.

Field	Type	Description
id	ID!	The ID of the object.
identifier	String!	The identifier of the vulnerability (e.g., CVE).
aliases	[String!]!	The aliases of the vulnerability.
summary	String	The summary of the vulnerability.
details	String	The detailed description of the vulnerability.
severity	VulnerabilitySeverity	Overall implied severity.
cvssV2Vector	String	CVSS v2 vector.
cvssV2BaseScore	Float	CVSS v2 base score.
cvssV2Severity	VulnerabilitySeverity	Severity based on the CVSSv2 base score.
cvssV3Vector	String	CVSS v3 vector.
cvssV3BaseScore	Float	CVSS v3 base score.
cvssV3Severity	VulnerabilitySeverity	Severity based on the CVSSv3 base score.
cvssV4Vector	String	CVSS v4 vector.
cvssV4BaseScore	Float	CVSS v4 base score.
cvssV4Severity	VulnerabilitySeverity	Severity based on the CVSSv4 base score.
epssScore	Float	The EPSS score of the vulnerability.
epssPercentile	Float	The EPSS percentile of the vulnerability.
introducedVersions	[String]!	Versions in which the vulnerability was introduced.
fixedVersions	[String]!	Versions in which the vulnerability was fixed.
referenceUrls	[String]!	Reference URLs for the vulnerability.
publishedAt	DateTime!	The time when the vulnerability was published.
updatedAt	DateTime!	The time when the vulnerability was updated.
withdrawnAt	DateTime	The time when the vulnerability was withdrawn.

RepositoryTarget

A Software Composition Analysis (SCA) target in a repository. Represents a manifest/lockfile pair for dependency scanning.

Field	Type	Description
id	ID!	The ID of the object.
ecosystem	Ecosystem!	The ecosystem of the target.
packageManager	PackageManager!	The package manager of the target.
manifestPath	String	Path to the manifest file.
lockfilePath	String!	Path to the lockfile.
source	RepositoryTargetSource!	The source of the target.
isActivated	Boolean!	Whether the target is activated.

RepositoryTargetConnection

Field	Type	Description
pageInfo	PageInfo!	Pagination data for this connection.
edges	[RepositoryTargetEdge]!	Contains the nodes in this connection.
totalCount	Int

RepositoryTargetEdge

A Relay edge containing a RepositoryTarget and its cursor.

Field	Type	Description
node	RepositoryTarget	The item at the end of the edge.
cursor	String!	A cursor for use in pagination.

Package

Represents a software package in a specific ecosystem.

Field	Type	Description
id	ID!	The ID of the object.
ecosystem	Ecosystem!	The ecosystem of the package.
name	String!	Name of the package.
purl	String	The package URL.

PackageVersion

Represents a specific version of a package.

Field	Type	Description
id	ID!	The ID of the object.
version	String!	Version of the package.
versionType	PackageVersionType	The type of the package version.

API Reference

Command Line Interface

Webhooks

​repository

​Arguments

​Sample Request

​Sample Response

​SCA Queries

​Fetching Repository Targets

​Fetching Dependency Vulnerabilities

​Fetching a Specific Vulnerability Occurrence

​Fetching a Specific Repository Target

​regenerateRepositoryDSN

​Arguments

​Sample Request

​Sample Response

​updateRepositoryDefaultBranch

​Arguments

​Sample Request

​Sample Response

​updateRepositoryIssueCategorySetting

​Arguments

​Sample Request

​Sample Response

​updateRepositoryMetricSetting

​Arguments

​Sample Request

​Sample Response

​activateRepository

​Arguments

​Sample Request

​Sample Response

​deactivateRepository

​Arguments

​Sample Request

​Sample Response

​Objects

​Repository

​RepositoryIssue

​RepositoryIssueConnection

​RepositoryIssueEdge

​RepositoryConnection

​RepositoryEdge

​RegenerateRepositoryDSNInput

​RegenerateRepositoryDSNPayload

​UpdateRepositoryDefaultBranchInput

​UpdateRepositoryDefaultBranchPayload

​UpdateRepositoryIssueCategorySettingInput

​UpdateRepositoryIssueCategorySettingPayload

​UpdateRepositoryMetricSettingInput

​UpdateRepositoryMetricSettingPayload

​ActivateRepositoryInput

​ActivateRepositoryPayload

​DeactivateRepositoryInput

​DeactivateRepositoryPayload

​VulnerabilityOccurrence

​VulnerabilityOccurrenceConnection

​VulnerabilityOccurrenceEdge

​Vulnerability

​RepositoryTarget

​RepositoryTargetConnection

​RepositoryTargetEdge

​Package

​PackageVersion

repository

Arguments

Sample Request

Sample Response

SCA Queries

Fetching Repository Targets

Fetching Dependency Vulnerabilities

Fetching a Specific Vulnerability Occurrence

Fetching a Specific Repository Target

regenerateRepositoryDSN

Arguments

Sample Request

Sample Response

updateRepositoryDefaultBranch

Arguments

Sample Request

Sample Response

updateRepositoryIssueCategorySetting

Arguments

Sample Request

Sample Response

updateRepositoryMetricSetting

Arguments

Sample Request

Sample Response

activateRepository

Arguments

Sample Request

Sample Response

deactivateRepository

Arguments

Sample Request

Sample Response

Objects

Repository

RepositoryIssue

RepositoryIssueConnection

RepositoryIssueEdge

RepositoryConnection

RepositoryEdge

RegenerateRepositoryDSNInput

RegenerateRepositoryDSNPayload

UpdateRepositoryDefaultBranchInput

UpdateRepositoryDefaultBranchPayload

UpdateRepositoryIssueCategorySettingInput

UpdateRepositoryIssueCategorySettingPayload

UpdateRepositoryMetricSettingInput

UpdateRepositoryMetricSettingPayload

ActivateRepositoryInput

ActivateRepositoryPayload

DeactivateRepositoryInput

DeactivateRepositoryPayload

VulnerabilityOccurrence

VulnerabilityOccurrenceConnection

VulnerabilityOccurrenceEdge

Vulnerability

RepositoryTarget

RepositoryTargetConnection

RepositoryTargetEdge

Package

PackageVersion