GIgitguardian
Sources

List sources

Changed on

List sources known by GitGuardian.

get/v1/sources

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/sources
  • Auth
    HTTP bearer

Query parameters

cursorstring

Pagination cursor.

pageinteger

Page number.

per_pageinteger

Number of items to list per page.

searchstring

Sources matching this search.

Example:test-repository
full_pathstring

Filter by the exact, case-sensitive full_path of the source, as returned by this endpoint. Prefer it over search to look up a single source.

Example:gitguardian/test-repository
last_scan_status'launched' | 'pending' | 'running' | 'finished' | 'failed' | 'canceled' | 'too_large' | 'timeout' | 'skipped' | 'pending_timeout' | 'running_failed' | 'running_cancelled'

Filter sources based on the status of their latest historical scan.

health'safe' | 'unknown' | 'at_risk'

Filter sources based on their health status.

type'bitbucket' | 'bitbucket_cloud' | 'github' | 'gitlab' | 'azure_devops' | 'slack' | 'jira_cloud' | 'confluence_cloud' | 'microsoft_teams' | 'confluence_data_center' | 'jira_data_center' | 'aws_ecr' | 'azure_cr' | 'google_artifact' | 'jfrog_artifact' | 'docker_hub' | 'servicenow' | 'sharepoint_online' | 'sharepoint_online_drive' | 'sharepoint_online_pages' | 'microsoft_onedrive' | 'custom_source' | 'nhi_source'

Filter by source type.

Example:github
ordering'last_scan_date' | '-last_scan_date'

Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

visibility'public' | 'private' | 'internal'

Filter by visibility status.

Example:public
external_idstring

Filter by specific external id.

Example:1
source_criticality'critical' | 'high' | 'medium' | 'low' | 'unknown'

Filter by source criticality.

Example:critical
monitoredboolean

Filter by monitored value.

provider_metadata_archivedboolean

Filter by whether the source is archived on the provider side when that information is available (e.g. archived repository). Sources without this metadata are treated as not archived for this filter.

Example:true
team_idinteger

Filter by the id of a team. Only sources belonging to the given team's perimeter are returned. Sources outside of the requester's accessible perimeter are still hidden.

Example:42
monitoring_status__instring
Example:archived,unreachable

Keep only sources whose real-time monitoring status is one of the given (comma-separated) buckets. Requires the monitoring-status feature to be enabled for the workspace; otherwise the parameter is ignored. The unreachable and disabled buckets are not fully backed yet.

monitoring_status__ninstring
Example:deleted_on_remote

Exclude sources whose real-time monitoring status is one of the given (comma-separated) buckets. Requires the monitoring-status feature to be enabled for the workspace; otherwise the parameter is ignored.

Response

Source List

idinteger
urlstring uri
typestring
full_namestring
full_pathstring nullable

Path of the repository on its VCS provider (GitHub, GitHub Enterprise, GitLab, Bitbucket, Bitbucket Cloud, Azure DevOps, Gerrit). It can differ from full_name, e.g. on GitLab. null for other source types.

health'safe' | 'unknown' | 'at_risk'
default_branchstring nullable

Default branch of the source repository.

default_branch_headstring nullable

Reference of the HEAD of the default branch.

open_incidents_countinteger

Number of open secret incidents with at least one occurrence on this source.

closed_incidents_countinteger

Number of closed secret incidents with at least one occurrence on this source.

visibilitystring
external_idstring

VCS identifier of the source (e.g.: the GitHub id for a GitHub repository). Warning: external_id is a string because some VCS ids can be UUIDs.

source_criticalitystring

Criticality of the source.

monitoredboolean

Deprecated: use monitoring_status to read a source's real-time monitoring state (monitoring_status distinguishes disabled, archived, unreachable and deleted-on-remote sources, which this boolean cannot). Whether the source is currently monitored by GitGuardian.

monitoring_status'active' | 'disabled' | 'unreachable' | 'archived' | 'deleted_on_remote'

Real-time monitoring status of the source. Note: the unreachable and disabled buckets are not fully backed yet and may report active until the supporting backend lands.

deletedboolean

Whether the source has been deleted

Example response

[
  {
    "id": 6531,
    "url": "https://github.com/GitGuardian/gg-shield",
    "type": "github",
    "full_name": "gitguardian/gg-shield",
    "full_path": "GitGuardian/ggshield",
    "health": "at_risk",
    "default_branch": "main",
    "default_branch_head": "abcd97b4aaf927ea934504263322e75e86c31xyz",
    "open_incidents_count": 3,
    "closed_incidents_count": 2,
    "visibility": "public",
    "external_id": "125",
    "source_criticality": "critical",
    "last_scan": {
      "date": "2021-05-20T12:40:55.662949Z",
      "status": "finished",
      "failing_reason": "DMCA takedown",
      "commits_scanned": 123,
      "branches_scanned": 2,
      "duration": "1:30.454444"
    },
    "monitored": true,
    "monitoring_status": "active",
    "deleted": true
  }
]

Changes

  • 09a630bb1566Revision changes
    • info

      added the new optional query request parameter full_path

    • info

      added the optional property / to the response with the status

  • 14abd988a9dcRevision changes
    • info

      added the enum value nhi_source to the property allOf[subschema #1]/ of the query request parameter type