Amazon Web Services, Inc.

Amazon GuardDuty

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following foundational data sources - VPC flow logs, Amazon Web…

Identity & security#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following foundational data sources - VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event logs, EKS audit logs, DNS logs, Amazon EBS volume data, runtime activity belonging to container workloads, such as Amazon EKS, Amazon ECS (including Amazon Web Services Fargate), and Amazon EC2 instances. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances and container workloads. For example, GuardDuty can detect compromised EC2 instances and container workloads serving malware, or mining bitcoin. GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength. GuardDuty informs you about the status of your Amazon Web Services environment by producing security findings that you can view in the GuardDuty console or through Amazon EventBridge. For more information, see the Amazon GuardDuty User Guide .

Endpoints 103

  • GETGet administrator account/detector/:DetectorId/administratorProvides the details of the GuardDuty administrator account associated with the current GuardDuty member account. Based on the type of account that runs this…
  • POSTAccept administrator invitation/detector/:DetectorId/administratorAccepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.
  • GETGet master account/detector/:DetectorId/masterDeprecated. Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
  • POSTAccept invitation/detector/:DetectorId/masterDeprecated. Accepts the invitation to be monitored by a GuardDuty administrator account.
  • POSTArchive findings/detector/:DetectorId/findings/archiveArchives GuardDuty findings that are specified by the list of finding IDs. Only the administrator account can archive findings. Member accounts don't have…
  • GETList custom detection rule associations/custom-detection-rule/association?maxResults=0&nextToken=string&ruleId=string&mode=stringReturns all custom detection rule associations for your account. You can filter by rule ID and mode.
  • POSTCreate custom detection rule association/custom-detection-rule/associationEnables a custom detection rule for your account by creating an association. You specify the rule and the mode in which it operates.
  • GETList custom detection rule org configurations/custom-detection-rule/org-configuration?maxResults=0&nextToken=string&status=stringReturns all organization-level configurations for custom detection rules. You can filter the results by status.
  • POSTCreate custom detection rule org configuration/custom-detection-rule/org-configurationCreates an organization-level configuration that enables a custom detection rule across your organization. This operation is available only to the delegated…
  • GETList detectors/detector?maxResults=0&nextToken=stringLists detectorIds of all the existing Amazon GuardDuty detector resources.
  • POSTCreate detector/detectorCreates a single GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in…
  • GETList filters/detector/:DetectorId/filter?maxResults=0&nextToken=stringReturns a paginated list of the current filters.
  • POSTCreate filter/detector/:DetectorId/filterCreates a filter using the specified finding criteria. The maximum number of saved filters per Amazon Web Services account per Region is 100. For more…
  • GETList iP sets/detector/:DetectorId/ipset?maxResults=0&nextToken=stringLists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets…
  • POSTCreate iP set/detector/:DetectorId/ipsetCreates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure…
  • POSTCreate investigation/detector/:DetectorId/investigationThis API is currently available as a preview. During the preview, you can initiate up to 10 investigations per account per day, with a total limit of 100…
  • GETList malware protection plans/malware-protection-plan?nextToken=stringLists the Malware Protection plan IDs associated with the protected resources in your Amazon Web Services account.
  • POSTCreate malware protection plan/malware-protection-planCreates a new Malware Protection plan for the protected resource. When you create a Malware Protection plan, the Amazon Web Services service terms for…
  • GETList members/detector/:DetectorId/member?maxResults=0&nextToken=string&onlyAssociated=stringLists details about all member accounts for the current GuardDuty administrator account.
  • POSTCreate members/detector/:DetectorId/memberCreates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for…
  • GETList publishing destinations/detector/:DetectorId/publishingDestination?maxResults=0&nextToken=stringReturns a list of publishing destinations associated with the specified detectorId .
  • POSTCreate publishing destination/detector/:DetectorId/publishingDestinationCreates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.
  • POSTCreate sample findings/detector/:DetectorId/findings/createGenerates sample findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes , the API generates sample findings of all…
  • GETList threat entity sets/detector/:DetectorId/threatentityset?maxResults=0&nextToken=stringLists the threat entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the threat entity sets that…
  • POSTCreate threat entity set/detector/:DetectorId/threatentitysetCreates a new threat entity set. In a threat entity set, you can provide known malicious threat entities for your Amazon Web Services environment. GuardDuty…
  • GETList threat intel sets/detector/:DetectorId/threatintelset?maxResults=0&nextToken=stringLists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets…
  • POSTCreate threat intel set/detector/:DetectorId/threatintelsetCreates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of…
  • GETList trusted entity sets/detector/:DetectorId/trustedentityset?maxResults=0&nextToken=stringLists the trusted entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the trusted entity sets…
  • POSTCreate trusted entity set/detector/:DetectorId/trustedentitysetCreates a new trusted entity set. In the trusted entity set, you can provide IP addresses and domains that you believe are secure for communication in your…
  • POSTDecline invitations/invitation/declineDeclines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
  • GETGet custom detection rule association/custom-detection-rule/rule/:RuleId/association/:AssociationIdReturns details for a custom detection rule association.
  • PUTUpdate custom detection rule association/custom-detection-rule/rule/:RuleId/association/:AssociationIdUpdates the mode of an existing custom detection rule association.
  • DELETEDelete custom detection rule association/custom-detection-rule/rule/:RuleId/association/:AssociationIdDisables a custom detection rule by deleting its association. This operation is idempotent.
  • GETGet custom detection rule org configuration/custom-detection-rule/org-configuration/:RuleId?mode=stringReturns the organization-level configuration for a custom detection rule.
  • PUTUpdate custom detection rule org configuration/custom-detection-rule/org-configuration/:RuleIdUpdates the organization-level configuration for a custom detection rule, including the mode and include/exclude account lists.
  • DELETEDelete custom detection rule org configuration/custom-detection-rule/org-configuration/:RuleId?mode=stringDeletes the organization-level configuration for a custom detection rule. This operation is available only to the delegated administrator account.
  • GETGet detector/detector/:DetectorIdRetrieves a GuardDuty detector specified by the detectorId. There might be regional differences because some data sources might not be available in all the…
  • POSTUpdate detector/detector/:DetectorIdUpdates the GuardDuty detector specified by the detector ID. Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime Monitoring (…
  • DELETEDelete detector/detector/:DetectorIdDeletes an Amazon GuardDuty detector that is specified by the detector ID.
  • GETGet filter/detector/:DetectorId/filter/:FilterNameReturns the details of the filter specified by the filter name.
  • POSTUpdate filter/detector/:DetectorId/filter/:FilterNameUpdates the filter specified by the filter name.
  • DELETEDelete filter/detector/:DetectorId/filter/:FilterNameDeletes the filter specified by the filter name.
  • GETGet iP set/detector/:DetectorId/ipset/:IpSetIdRetrieves the IPSet specified by the ipSetId .
  • POSTUpdate iP set/detector/:DetectorId/ipset/:IpSetIdUpdates the IPSet specified by the IPSet ID.
  • DELETEDelete iP set/detector/:DetectorId/ipset/:IpSetIdDeletes the IPSet specified by the ipSetId . IPSets are called trusted IP lists in the console user interface.
  • POSTDelete invitations/invitation/deleteDeletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.
  • GETGet malware protection plan/malware-protection-plan/:MalwareProtectionPlanIdRetrieves the Malware Protection plan details associated with a Malware Protection plan ID.
  • DELETEDelete malware protection plan/malware-protection-plan/:MalwareProtectionPlanIdDeletes the Malware Protection plan ID associated with the Malware Protection plan resource. Use this API only when you no longer want to protect the resource…
  • PATCHUpdate malware protection plan/malware-protection-plan/:MalwareProtectionPlanIdUpdates an existing Malware Protection plan resource.
  • POSTDelete members/detector/:DetectorId/member/deleteDeletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs. With autoEnableOrganizationMembers…
  • GETDescribe publishing destination/detector/:DetectorId/publishingDestination/:DestinationIdReturns information about the publishing destination specified by the provided destinationId .
  • POSTUpdate publishing destination/detector/:DetectorId/publishingDestination/:DestinationIdUpdates information about the publishing destination specified by the destinationId .
  • DELETEDelete publishing destination/detector/:DetectorId/publishingDestination/:DestinationIdDeletes the publishing definition with the specified destinationId .
  • GETGet threat entity set/detector/:DetectorId/threatentityset/:ThreatEntitySetIdRetrieves the threat entity set associated with the specified threatEntitySetId .
  • POSTUpdate threat entity set/detector/:DetectorId/threatentityset/:ThreatEntitySetIdUpdates the threat entity set associated with the specified threatEntitySetId .
  • DELETEDelete threat entity set/detector/:DetectorId/threatentityset/:ThreatEntitySetIdDeletes the threat entity set that is associated with the specified threatEntitySetId .
  • GETGet threat intel set/detector/:DetectorId/threatintelset/:ThreatIntelSetIdRetrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
  • POSTUpdate threat intel set/detector/:DetectorId/threatintelset/:ThreatIntelSetIdUpdates the ThreatIntelSet specified by the ThreatIntelSet ID.
  • DELETEDelete threat intel set/detector/:DetectorId/threatintelset/:ThreatIntelSetIdDeletes the ThreatIntelSet specified by the ThreatIntelSet ID.
  • GETGet trusted entity set/detector/:DetectorId/trustedentityset/:TrustedEntitySetIdRetrieves the trusted entity set associated with the specified trustedEntitySetId .
  • POSTUpdate trusted entity set/detector/:DetectorId/trustedentityset/:TrustedEntitySetIdUpdates the trusted entity set associated with the specified trustedEntitySetId .
  • DELETEDelete trusted entity set/detector/:DetectorId/trustedentityset/:TrustedEntitySetIdDeletes the trusted entity set that is associated with the specified trustedEntitySetId .
  • POSTDescribe malware scans/detector/:DetectorId/malware-scansReturns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all…
  • GETDescribe organization configuration/detector/:DetectorId/admin?maxResults=0&nextToken=stringReturns information about the account selected as the delegated administrator for GuardDuty. There might be regional differences because some data sources…
  • POSTUpdate organization configuration/detector/:DetectorId/adminConfigures the delegated administrator account with the provided values. You must provide a value for either autoEnableOrganizationMembers or autoEnable , but…
  • POSTDisable organization admin account/admin/disableRemoves the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.
  • POSTDisassociate from administrator account/detector/:DetectorId/administrator/disassociateDisassociates the current GuardDuty member account from its administrator account. When you disassociate an invited member from a GuardDuty delegated…
  • POSTDisassociate from master account/detector/:DetectorId/master/disassociateDeprecated. Disassociates the current GuardDuty member account from its administrator account. When you disassociate an invited member from a GuardDuty…
  • POSTDisassociate members/detector/:DetectorId/member/disassociateDisassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs. When you disassociate an invited member from a…
  • POSTEnable organization admin account/admin/enableDesignates an Amazon Web Services account within the organization as your GuardDuty delegated administrator. Only the organization's management account can…
  • POSTGet coverage statistics/detector/:DetectorId/coverage/statisticsRetrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with…
  • GETGet custom detection rule/custom-detection-rule/rule/:RuleIdReturns details for a custom detection rule in GuardDuty, including its detection logic.
  • POSTGet findings/detector/:DetectorId/findings/getDescribes Amazon GuardDuty findings specified by finding IDs.
  • POSTGet findings statistics/detector/:DetectorId/findings/statisticsLists GuardDuty findings statistics for the specified detector ID. You must provide either findingStatisticTypes or groupBy parameter, and not both. You can…
  • GETGet investigation/detector/:DetectorId/investigation/:InvestigationId?summaryFormat=stringThis API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio),…
  • GETGet invitations count/invitation/countReturns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
  • GETGet malware scan/malware-scan/:ScanIdRetrieves the detailed information for a specific malware scan. Each member account can view the malware scan details for their own account. An administrator…
  • GETGet malware scan settings/detector/:DetectorId/malware-scan-settingsReturns the details of the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web…
  • POSTUpdate malware scan settings/detector/:DetectorId/malware-scan-settingsUpdates the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions…
  • POSTGet member detectors/detector/:DetectorId/member/detector/getDescribes which data sources are enabled for the member account's detector. There might be regional differences because some data sources might not be…
  • POSTGet members/detector/:DetectorId/member/getRetrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
  • GETGet organization statistics/organization/statisticsRetrieves how many active member accounts have each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this…
  • POSTGet remaining free trial days/detector/:DetectorId/freeTrial/daysRemainingProvides the number of days left for each data source used in the free trial period.
  • POSTGet usage statistics/detector/:DetectorId/usage/statisticsLists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources, the cost returned…
  • POSTInvite members/detector/:DetectorId/member/inviteInvites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are…
  • POSTList coverage/detector/:DetectorId/coverageLists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member…
  • POSTList custom detection rules/custom-detection-rule/ruleReturns all available custom detection rules in GuardDuty. You can filter the results by data source, severity, tactic, technique, and service.
  • POSTList findings/detector/:DetectorId/findingsLists GuardDuty findings for the specified detector ID. There might be regional differences because some flags might not be available in all the Regions where…
  • POSTList investigation records/detector/:DetectorId/investigation/recordsThis API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio),…
  • POSTList investigations/detector/:DetectorId/investigation/listThis API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio),…
  • GETList invitations/invitation?maxResults=0&nextToken=stringLists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.
  • POSTList malware scans/malware-scan?maxResults=0&nextToken=stringReturns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all of…
  • GETList organization admin accounts/admin?maxResults=0&nextToken=stringLists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.
  • GETList tags for resource/tags/:ResourceArnLists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit…
  • POSTTag resource/tags/:ResourceArnAdds tags to a resource.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes tags from a resource.
  • POSTSend object malware scan/object-malware-scan/sendInitiates a malware scan for a specific S3 object. This API allows you to perform on-demand malware scanning of individual objects in S3 buckets that have…
  • POSTStart malware scan/malware-scan/startInitiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account if the resourceArn belongs to an…
  • POSTStart monitoring members/detector/:DetectorId/member/startTurns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the…
  • POSTStop monitoring members/detector/:DetectorId/member/stopStops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts. With…
  • POSTUnarchive findings/detector/:DetectorId/findings/unarchiveUnarchives GuardDuty findings specified by the findingIds .
  • POSTUpdate findings feedback/detector/:DetectorId/findings/feedbackMarks the specified GuardDuty findings as useful or not useful.
  • POSTUpdate member detectors/detector/:DetectorId/member/detector/updateContains information on member accounts to be updated. Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime Monitoring (…

API details

Base URL
https://guardduty.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
103 operations on 66 pathsPOST 56GET 33DELETE 11PUT 2PATCH 1
3 marked deprecated
Description format
AWS Smithy model, API version 2017-11-28

How to test the Amazon GuardDuty in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon GuardDuty collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get administrator account” (GET /detector/:DetectorId/administrator), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon GuardDuty?

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following foundational data sources - VPC flow logs, Amazon Web… It is listed under Identity & security and has 103 endpoints.

Who publishes the Amazon GuardDuty?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon GuardDuty?

Requests go to https://guardduty.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon GuardDuty?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon GuardDuty have?

103 operations on 66 paths (56 POST, 33 GET, 11 DELETE, 2 PUT, 1 PATCH).

Is forking the Amazon GuardDuty free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.