NHI Sources

List the sources that send non-human identities to GitGuardian: secrets managers, consumers such as Kubernetes clusters or CI systems, cloud providers and endpoints.

Use the source ids to filter identities with vault_source_id__in, consumer_source_id__in, endpoint_source_id__in and provider_source_id__in.

The response contains a page of sources and a pagination cursor to retrieve the next page. The sources are sorted by id.

The API token must have the Manager access level or above, or be a service account token.

get/v1/nhi/sources

Request

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

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

searchstring

Search on the identifier of the source.

typestring

Source types, comma-separated.

is_vaultboolean

Keep only the secrets managers (true) or the other sources (false).

activeboolean

Keep only the sources seen (true) or not seen (false) within the workspace's activity period.

Response

A page of sources.

idinteger required
typestring required
display_namestring required
identifierstring required

Identifier of the source, such as its URL.

last_seen_atstring date-time required
status'active' | 'stale' required

stale when the source was not seen within the workspace activity period.

ownerstring email nullable
is_monitoredboolean nullable

Example response

[
  {
    "id": 56,
    "type": "hashicorpvault",
    "identifier": "https://vault.example.com"
  }
]

Changes