--- title: "ListNotifications" method: GET path: "/v1/namespaces/{tenant_meta.namespace}/notifications" tags: ["NotificationService"] --- # ListNotifications `GET /v1/namespaces/{tenant_meta.namespace}/notifications` List all notifications. ## Path parameters - `tenant_meta.namespace` string, required ## Query parameters - `list_parameters.filter` string - `list_parameters.page_token` integer - `list_parameters.page_size` integer - `list_parameters.action` string - `list_parameters.mask` string - `list_parameters.traverse` boolean - `list_parameters.sort.path` string - `list_parameters.sort.order` 'SORT_ENTRY_ORDER_UNSPECIFIED' | 'SORT_ENTRY_ORDER_ASC' | 'SORT_ENTRY_ORDER_DESC' - `list_parameters.count` boolean - `list_parameters.group.aggregation_paths` string - `list_parameters.group.show_aggregation_uuids` boolean - `list_parameters.group.unique_count_paths` string - `list_parameters.group.unique_value_paths` string - `list_parameters.ci_run_uuid` string - `list_parameters.page_id` string - `list_parameters.group_by_time.aggregation_paths` string - `list_parameters.group_by_time.show_aggregation_uuids` boolean - `list_parameters.group_by_time.interval` 'GROUP_BY_TIME_INTERVAL_UNSPECIFIED' | 'GROUP_BY_TIME_INTERVAL_YEAR' | 'GROUP_BY_TIME_INTERVAL_QUARTER' | 'GROUP_BY_TIME_INTERVAL_MONTH' | 'GROUP_BY_TIME_INTERVAL_WEEK' | 'GROUP_BY_TIME_INTERVAL_DAY' | 'GROUP_BY_TIME_INTERVAL_HOUR' | 'GROUP_BY_TIME_INTERVAL_MINUTE' | 'GROUP_BY_TIME_INTERVAL_SECOND' - `list_parameters.group_by_time.group_size` integer - `list_parameters.group_by_time.start_time` string, date-time - `list_parameters.group_by_time.end_time` string, date-time - `list_parameters.group_by_time.mode` string - `list_parameters.group_by_time.aggregation_value_field` string - `list_parameters.group_by_time.aggregation_operator` string - `list_parameters.disable_pagination` boolean ## Response `200` A successful response. - V1ListNotificationsResponse — Response returned for requests to list notifications. - `count_response` V1CountResponse — Response to a list count request. - `count` integer — Number of objects matching the given list parameters. - `group_response` V1GroupResponse — Response to a list group request. - `groups` object — Map indexed by values of the fields specified in aggregation_paths, for example, {"[{"key":"meta.kind","value":"Project"}]": { "aggregation_count": { "count": 1649 } } }. - `list` V1ListNotificationsResponseList - `objects` V1Notification[] - `context` V1Context — Contexts keep objects from different scans separated. - `id` string, required — The context ID, such as a pull request ID or branch reference. - `tags` string[] — A list of tags applied to a context. Used primarily for CI and SBOM contexts. - `type` 'CONTEXT_TYPE_UNSPECIFIED' | 'CONTEXT_TYPE_MAIN' | 'CONTEXT_TYPE_EXTERNAL' | 'CONTEXT_TYPE_CI_RUN' | 'CONTEXT_TYPE_SBOM' | 'CONTEXT_TYPE_REF', required — - CONTEXT_TYPE_MAIN: Objects from a scan of the default branch. All objects in the oss namespace are in the main context. The context id is always "default". - CONTEXT_TYPE_EXTERNAL: Indicates that this object is a copy/temporary value of an object in another project. Used for same-tenant dependencies. In source code reference this is equivalent to "vendor" folders. Package versions in the external context are only scanned for call graphs. No other operations are performed on them. - CONTEXT_TYPE_CI_RUN: Objects from a PR scan. The context id is the PR UUID. Objects in this context are deleted after 30 days. - CONTEXT_TYPE_SBOM: Objects from an SBOM scan. The context id is the SBOM serial number or some other unique identifier. - CONTEXT_TYPE_REF: Objects from a scan of a specific branch. The context id is the branch reference name. - `will_be_deleted_at` string, date-time — Time that all objects in this context will be deleted. This field is deprecated and will be removed in the future. Please use the meta.will_be_deleted_at field instead. - `meta` V1Meta, required — Common fields for all Endor Labs resources. - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string — Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float — search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time — Time that the resource will be deleted. - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required — Resource name. Must be 63 characters or less. - `parent_kind` string — Parent object resource kind, for example, Project. - `parent_uuid` string — Parent object UUID. - `references` object — Map of objects referenced in a query API. - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string — Message version. - `spec` V1NotificationSpec, required - `aggregation_details` SpecAggregationDetails — The findings are aggregated and notifications are sent based on the aggregation details. - `aggregation_target_name` string - `aggregation_type` 'AGGREGATION_TYPE_UNSPECIFIED' | 'AGGREGATION_TYPE_PROJECT' | 'AGGREGATION_TYPE_DEPENDENCY' | 'AGGREGATION_TYPE_DEPENDENCY_ACROSS_PKG_VERSIONS' | 'AGGREGATION_TYPE_NONE' | 'AGGREGATION_TYPE_MANUAL' — - AGGREGATION_TYPE_PROJECT: AGGREGATION_TYPE_PROJECT aggregates notifications by project. - AGGREGATION_TYPE_DEPENDENCY: AGGREGATION_TYPE_DEPENDENCY aggregates notifications by dependency, root package version, and project. - AGGREGATION_TYPE_DEPENDENCY_ACROSS_PKG_VERSIONS: AGGREGATION_TYPE_DEPENDENCY_ACROSS_PKG_VERSIONS aggregates notifications by dependency and project, regardless of the package version. - AGGREGATION_TYPE_NONE: AGGREGATION_TYPE_NONE does not aggregate notifications - AGGREGATION_TYPE_MANUAL: AGGREGATION_TYPE_MANUAL identifies notifications created directly from findings via the UI. Each finding results in a separate notification. - `pkg_version_name` string - `pkg_version_uuid` string — The UUID of the package version. - `diff` V1NotificationDiff - `new_finding_uuids` string[] - `resolved_finding_uuids` string[] - `dismiss` SpecNotificationDismiss - `category` 'NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED' | 'NOTIFICATION_DISMISS_CATEGORY_FALSE_POSITIVE' | 'NOTIFICATION_DISMISS_CATEGORY_MITIGATED' | 'NOTIFICATION_DISMISS_CATEGORY_LOW_PRIORITY' — - NOTIFICATION_DISMISS_CATEGORY_FALSE_POSITIVE: The notification is a false alarm. - NOTIFICATION_DISMISS_CATEGORY_MITIGATED: The notification has been taken care of. - NOTIFICATION_DISMISS_CATEGORY_LOW_PRIORITY: The notification is of low priority and doesn't need immediate attention. - `comment` string - `time` string, date-time — The time is when the notification was last dismissed. - `finding_details` object — The map of finding UUID to finding object. - `hashsum` string — The SHA-256 hash sum of the notification payload. The notification payload is a list of UUIDs (of say Findings/Metrics) and/or an opaque blob. The list of UUIDs and the opaque data is used as input for the hashing function. The hashsum is used to determine if the latest notification payload has changed so as to update the notification target when there is a change. - `last_seen_at` string, date-time — The time when the notification was last raised. - `notification_action_data` object — A map of metadata related to the notification action, indexed by the notification target UUID. It maintains the following information related to every notification target. - Flags to determine if an action related to a notification target is successfully completed or not. If not, the action is retried in subsequent attempts. Flags are maintained for actions related to OPEN/UPDATE/RESOLVE. - Metadata specific to a notification target type. Some of the notification target types need to maintain state so that subsequent updates to the notifications can operate on the same entity created by the notification. For example, JIRA updates needs to be performed on the same JIRA issue and hence the need to store JIRA ID. - `notification_external_ids` string[] — The ids/keys of the tickets created by notification. - `payload` V1NotificationPayload - `policy_output` V1PolicyOutput - `allow` boolean — True if input data is accepted by policy. False if input data violates the expected state. - `raw` object[] — Raw policy output. - … - `violating_resources` object — Lists of UUIDs of resources that violate the policy, if applicable, indexed by resource name. - `policy_type` 'POLICY_TYPE_UNSPECIFIED' | 'POLICY_TYPE_ADMISSION' | 'POLICY_TYPE_NOTIFICATION' | 'POLICY_TYPE_FINDING' | 'POLICY_TYPE_FINDING_CFG' | 'POLICY_TYPE_ML_FINDING' | 'POLICY_TYPE_SYSTEM_FINDING' | 'POLICY_TYPE_USER_FINDING' | 'POLICY_TYPE_EXCEPTION' | 'POLICY_TYPE_REMEDIATION' — - POLICY_TYPE_ADMISSION: POLICY_TYPE_ADMISSION will admit/reject pipeline runs. Admission policies operate on Findings and are run during a CI/CD pipeline. They may return data such as the uuids of findings that violate the policy. - POLICY_TYPE_NOTIFICATION: POLICY_TYPE_NOTIFICATION is for policies that generate notifications. - POLICY_TYPE_ML_FINDING: ML finding policies enable or disable algorithmic findings. Note that there is no input data for these policies, they always return output, and the allowed value is ignored. - POLICY_TYPE_SYSTEM_FINDING: A system finding policy is created from a system policy template. It processes data and creates new findings. System finding policies are run together with user and ML (a.k.a. algorithmic) findings. System finding policies can only be enabled, disabled, and edited. They cannot be created or deleted. - POLICY_TYPE_USER_FINDING: A user finding policy is created from scratch or from a customer policy template. It processes data and creates new findings. User finding policies are run together with system and ML (a.k.a. algorithmic) findings. User finding policies can be created, enabled, disabled, edited, and deleted. - POLICY_TYPE_EXCEPTION: An exception policy identifies findings which should be excluded from admission and notification policies. It is created from scratch or from an exception policy template. - POLICY_TYPE_REMEDIATION: A remediation policy identifies findings which should be remediated. It is created from scratch or from a remediation policy template. - `policy_uuid` string — The UUID of the policy to which this notification belongs. Optional. Notifications created directly from findings do not have policy_uuid. - `project_uuid` string, required — The UUID of the project to which this notification belongs. - `remediation_parameters` V1RemediationParameters — RemediationParameters holds the settings for remediation actions. - `automated_pr_parameters` RemediationParametersAutomatedPRParameters — AutomatedPRParameters holds the settings for automated PRs. - `language_parameters` object — Language-specific parameters for the pull request. - `max_open_prs` integer — Maximum number of open pull requests allowed. - `repository_version_uuid` string — The UUID of the repository version to which this notification belongs. - `resolved_at` string, date-time — The time when the notification was marked resolved. - `state` 'NOTIFICATION_STATE_UNSPECIFIED' | 'NOTIFICATION_STATE_OPEN_NOTIFICATION_PENDING' | 'NOTIFICATION_STATE_OPEN' | 'NOTIFICATION_STATE_DISMISSED' | 'NOTIFICATION_STATE_SNOOZED' | 'NOTIFICATION_STATE_RESOLVED_NOTIFICATION_PENDING' | 'NOTIFICATION_STATE_RESOLVED' | 'NOTIFICATION_STATE_DELETED', required — - NOTIFICATION_STATE_OPEN_NOTIFICATION_PENDING: New Notification has been created but notification is pending. - NOTIFICATION_STATE_OPEN: New Notification has been created and notification has been sent. - NOTIFICATION_STATE_DISMISSED: Notification has been dismissed by the user. - NOTIFICATION_STATE_SNOOZED: Notification has been snoozed by the user. Not used yet. - NOTIFICATION_STATE_RESOLVED_NOTIFICATION_PENDING: Notification has been resolved but notification is pending. - NOTIFICATION_STATE_RESOLVED: Notification has been resolved and the notification has been sent. - NOTIFICATION_STATE_DELETED: Notification has been marked for deletion. - `tenant_meta` V1TenantMeta — Tenant related data for the tenant containing the resource. - `namespace` string, required — Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". - `uuid` string — The UUID of a notification. - `response` V1ListResponse — Response to a list request. - `next_page_id` string — The UUID of last message retrieved. - `next_page_token` integer — Pagination token that can be used to retrieve the next page of results. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference.md) · [All operations](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/endorlabs/endor-labs-rest-api-reference/revisions/2fe1f84213b3/schema)