--- title: "ListNotificationTargets" method: GET path: "/v1/namespaces/{tenant_meta.namespace}/notification-targets" tags: ["NotificationTargetService"] --- # ListNotificationTargets `GET /v1/namespaces/{tenant_meta.namespace}/notification-targets` Lists all notification targets. ## 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. - V1ListNotificationTargetsResponse — Response returned for requests to list notification targets. - `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` V1ListNotificationTargetsResponseList - `objects` V1NotificationTarget[] - `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. - `propagate` boolean — Indicates whether the object should be visible in the child namespaces or not. - `spec` V1NotificationTargetSpec, required - `action` NotificationTargetNotificationTargetAction, required - `action_type` 'ACTION_TYPE_UNSPECIFIED' | 'ACTION_TYPE_WEBHOOK' | 'ACTION_TYPE_JIRA' | 'ACTION_TYPE_EMAIL' | 'ACTION_TYPE_VANTA' | 'ACTION_TYPE_SLACK' | 'ACTION_TYPE_GITHUB_PR' | 'ACTION_TYPE_ADO_BOARDS', required — - ACTION_TYPE_WEBHOOK: ACTION_TYPE_WEBHOOK indicates a webhook call action. - ACTION_TYPE_JIRA: ACTION_TYPE_JIRA indicates a JIRA action. - ACTION_TYPE_EMAIL: ACTION_TYPE_EMAIL indicates an email action. - ACTION_TYPE_VANTA: ACTION_TYPE_VANTA indicates configuration of a Vanta plugin. - ACTION_TYPE_SLACK: ACTION_TYPE_SLACK indicates a Slack integration. - ACTION_TYPE_GITHUB_PR: ACTION_TYPE_GITHUB_PR indicates a GitHub PR action. - ACTION_TYPE_ADO_BOARDS: ACTION_TYPE_ADO_BOARDS indicates an ADO board action. - `ado_boards_config` V1ADOBoardsConfig — ADOBoardsConfig configures Azure DevOps Boards as a notification action target. - `installation_uuid` string — UUID of the installation that provides ADO credentials. - `projects` ADOBoardsConfigProjectConfig[], required — Projects to create work items in. At least one project must be specified. - … - `user_config` ADOBoardsConfigUserConfig — UserConfig holds org URL and auth provided directly by the user. - … - `email_config` V1EMailConfig - `receivers_addresses` string[], required - `exclude_endor_url` boolean — Excludes the URL to access the Endor Labs app which provides the notification details. - `github_pr_config` V1GitHubPRConfig - `enabled` boolean, required - `jira_config` V1JIRAConfig - `api_key` string — The API Key to authenticate with Jira. - `bearer_token` string — The bearer token to authenticate with Jira. - `cloud_id` string — The Jira Cloud ID required to route API requests through the Atlassian API gateway. - `components` string[] — The Components field in Jira board. - `custom_fields` JIRAConfigCustomField[] - … - `issue_type` 'JIRA_ISSUE_TYPE_UNSPECIFIED' | 'JIRA_ISSUE_TYPE_TASK' | 'JIRA_ISSUE_TYPE_BUG' — Deprecated: This enum will not be used. A string field will be used instead. - JIRA_ISSUE_TYPE_TASK: Indicates a Jira task. - JIRA_ISSUE_TYPE_BUG: Indicates a Jira Bug. - `jira_child_issue_type` string — Child issue type used for dependency aggregation. Optional. Defaults to the project's sub-task type when unset. - `jira_issue_type` string - `labels` string[], required — The labels to apply to the Jira issue. - `project_key` string, required — The project key in which the Jira issue is raised as an action for the notification. - `resolve_state` string — The final ticket status after resolving. - `url` string, required — The Jira endpoint. - `use_bearer_token` boolean — Denotes if we should use bearer token to authenticate with Jira. - `user_name` string — The user name to authenticate with Jira. - `public` boolean — Indicates if the action endpoint is public. If the endpoint not public, then endorctl attempts to create the action as if the endpoint is running on-prem. - `slack_config` V1SlackConfig - `webhook_url` string, required - `vanta_config` V1VantaConfig - `access_token_auth` VantaConfigVantaAccessTokenAuth - … - `api_key` string - `auth_method` 'VANTA_AUTH_METHOD_UNSPECIFIED' | 'VANTA_AUTH_METHOD_ACCESS_TOKEN' | 'VANTA_AUTH_METHOD_ACCESS_API_KEY', required — - VANTA_AUTH_METHOD_ACCESS_TOKEN: Uses basic username and password and retrieves an ephemeral access token for authentication. - VANTA_AUTH_METHOD_ACCESS_API_KEY: Uses an API key provided by the user. Note: This is just a placeholder and not yet implemented. - `package_vulnerability_resource_id` string — The Resource ID of the package vulnerability created in Vanta. - `sca_resource_id` string — The Resource ID of the static code analysis vulnerabilities created in Vanta. - `vulnerable_component_resource_id` string, required — The Resource ID of the vulnerable component created in Vanta. - `webhook_config` V1WebhookConfig - `api_key` string - `auth_method` 'WEBHOOK_AUTH_METHOD_UNSPECIFIED' | 'WEBHOOK_AUTH_METHOD_NONE' | 'WEBHOOK_AUTH_METHOD_BASIC' | 'WEBHOOK_AUTH_METHOD_API_KEY', required — - WEBHOOK_AUTH_METHOD_NONE: Uses no authentication. Not recommended. - WEBHOOK_AUTH_METHOD_BASIC: Uses basic username and password. - WEBHOOK_AUTH_METHOD_API_KEY: Uses an API key as credentials. - `basic_auth` WebhookConfigWebhookBasicAuth - … - `custom_headers` WebhookConfigWebhookHeader[] — Additional HTTP headers attached to every webhook request, evaluated independently of auth_method. Enables forwarding to systems that require non-Bearer auth headers (Datadog, Splunk, New Relic, Elastic). - … - `disable_hmac` boolean - `hmac_shared_secret` string - `url` string, required - `custom_template` V1CustomTemplate — CustomTemplate is the type specific custom template. - `email_template` V1EmailTemplate - `open_action_template` string — The template to be used for OPEN action for email plugin. - `resolve_action_template` string — The template to be used for RESOLVE action for email plugin. - `update_action_template` string — The template to be used for UPDATE action for email plugin. - `prcomments_template` V1PRCommentsTemplate - `findings_summary_template` string, required — The template for the PR comment for summary of findings. - `slack_template` V1SlackTemplate - `open_action_template` string — The template to be used for OPEN action for slack plugin. - `update_action_template` string — The template to be used for UPDATE action for slack plugin. - `template_type` 'CUSTOM_TEMPLATE_TYPE_UNSPECIFIED' | 'CUSTOM_TEMPLATE_TYPE_PR_COMMENTS' | 'CUSTOM_TEMPLATE_TYPE_EMAIL' | 'CUSTOM_TEMPLATE_TYPE_SLACK' | 'CUSTOM_TEMPLATE_TYPE_WEBHOOK', required - `webhook_template` V1WebhookTemplate - `open_action_template` string — The template to be used for OPEN action for webhook plugin. - `resolve_action_template` string — The template to be used for RESOLVE action for webhook plugin. - `update_action_template` string — The template to be used for UPDATE action for webhook plugin. - `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 the notification target. - `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)