--- title: "GetNotificationTarget" method: GET path: "/v1/namespaces/{tenant_meta.namespace}/notification-targets/{uuid}" tags: ["NotificationTargetService"] --- # GetNotificationTarget `GET /v1/namespaces/{tenant_meta.namespace}/notification-targets/{uuid}` ## Request - Base URL: `https://api.endorlabs.com` - URL: `https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/notification-targets/{uuid}` - Auth: none declared Fetches the notification target identified by the UUID. ## Path parameters - `tenant_meta.namespace` string, required - `uuid` string, required ## Query parameters - `get_parameters.mask` string ## Response `200` A successful response. - V1NotificationTarget: Indicates actions taken when a corresponding notification is raised. - `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' | 'ACTION_TYPE_REMEDIATION_PR', 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. Deprecated: Use ACTION_TYPE_REMEDIATION_PR, which supports all SCM platforms. - ACTION_TYPE_ADO_BOARDS: ACTION_TYPE_ADO_BOARDS indicates an ADO board action. - ACTION_TYPE_REMEDIATION_PR: ACTION_TYPE_REMEDIATION_PR indicates an automated remediation pull request action. The pull request is opened on the SCM platform of the violating project, for example a GitHub pull request or a GitLab merge request. - `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. - `child_work_item_type` string: Work item type to create as a child under the parent work item. - `project_guid` string: ADO project GUID. Populated server-side during validation. - `project_name` string, required: Project name in ADO. - `tags` string[]: The tags to apply to the ADO work item. - `work_item_type` string, required: Work item type to create, e.g., "Bug", "Task", "Epic". - `user_config` ADOBoardsConfigUserConfig: UserConfig holds org URL and auth provided directly by the user. - `auth` ADOBoardsConfigAuthConfig, required: AuthConfig holds the credentials used to authenticate with ADO. - `pat` AuthConfigPAT: PAT authenticates with ADO using a Personal Access Token. - … - `org_url` string, required: The URL of the ADO organization (e.g. https://dev.azure.com/myorg). - `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: GitHubPRConfig configures automated GitHub pull requests for remediations. Deprecated: Use RemediationPRConfig, which supports all SCM platforms. - `enabled` boolean, required: Turns the creation of automated pull requests on or off for this target. - `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[] - `key` string, required - `value` string, required - `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. - `remediation_pr_config` V1RemediationPRConfig: RemediationPRConfig configures automated remediation pull requests. The SCM platform is determined by the platform source of the violating project. - `enabled` boolean, required: Turns the creation of automated pull requests on or off for this target. - `slack_config` V1SlackConfig - `webhook_url` string, required - `vanta_config` V1VantaConfig - `access_token_auth` VantaConfigVantaAccessTokenAuth - `access_token` string - `client_id` string - `client_secret` string - `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 - `password` string - `username` string - `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). - `name` string, required: Header name. Must be a valid RFC 7230 token (letters, digits, and !#$%&'*+-.^_`|~). Reserved names (Content-Type, Authorization when an auth_method other than NONE is set, X-Endor-HMAC-Signature, and hop-by-hop headers) are rejected at send time. - `value` string, required: Header value sent verbatim. Stored as a secret (encrypted at rest, redacted in API responses) because values often hold API keys. - `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. ## Other responses - `default`: An unexpected error response. ## Changes - **2026-11-03** `4acd9fe15140`: 1 warning, 1 info - added the new `ACTION_TYPE_REMEDIATION_PR` enum value to the `spec/action/action_type` response property for the response status `200` - added the optional property `spec/action/remediation_pr_config` to the response with the `200` status [Operation history](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/changes/v1/namespaces/:tenant_meta.namespace/notification-targets/:uuid/get.md) --- [API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) - [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/revisions/4acd9fe15140?raw)