GIgitguardian
Team Sources

List team sources

Changed on

List sources belonging to a team's perimeter.

get/v1/teams/{team_id}/sources

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/teams/{team_id}/sources
  • Auth
    HTTP bearer

Path parameters

team_idinteger required

The id of the team

Query parameters

cursorstring

Pagination cursor.

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'azure_devops' | 'bitbucket' | 'bitbucket_cloud' | 'github' | 'gitlab'

Filter by integration 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

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

  • 511b067cdcb1Revision changes
    • warning

      added the new launched enum value to the //// response property for the response status

    • warning

      added the new running_cancelled enum value to the //// response property for the response status

    • warning

      added the new running_failed enum value to the //// response property for the response status

    • warning

      added the new skipped enum value to the //// response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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