Open documentation ↗Overview
<p>Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event logs, EKS audit logs, DNS logs, and Amazon EBS volume data. 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. </p> <p>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. </p> <p>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 <i> <a href="https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html">Amazon GuardDuty User Guide</a> </i>. </p>
Amazon GuardDuty is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 67 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2017-11-28
- Endpoints
- 67
- OpenAPI
- Specification ↗
- Spec updated
- 2020-05-09
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /detector/{detectorId}/administrator | Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account. |
| POST | /detector/{detectorId}/administrator | Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation. |
| GET | /detector/{detectorId}/masterdeprecated | Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account. |
| POST | /detector/{detectorId}/masterdeprecated | Accepts the invitation to be monitored by a GuardDuty administrator account. |
| POST | /detector/{detectorId}/findings/archive | <p>Archives GuardDuty findings that are specified by the list of finding IDs.</p> <note> <p>Only the administrator account can archive findings. Member accounts |
| GET | /detector | Lists detectorIds of all the existing Amazon GuardDuty detector resources. |
| POST | /detector | <p>Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detec |
| GET | /detector/{detectorId}/filter | Returns a paginated list of the current filters. |
| POST | /detector/{detectorId}/filter | Creates a filter using the specified finding criteria. The maximum number of saved filters per Amazon Web Services account per Region is 100. For more informati |
| GET | /detector/{detectorId}/ipset | Lists 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 from |
| POST | /detector/{detectorId}/ipset | Creates 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 communicati |
| GET | /detector/{detectorId}/member | Lists details about all member accounts for the current GuardDuty administrator account. |
| POST | /detector/{detectorId}/member | <p>Creates 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 m |
| GET | /detector/{detectorId}/publishingDestination | Returns a list of publishing destinations associated with the specified <code>detectorId</code>. |
| POST | /detector/{detectorId}/publishingDestination | Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation. |
| POST | /detector/{detectorId}/findings/create | Generates sample findings of types specified by the list of finding types. If 'NULL' is specified for <code>findingTypes</code>, the API generates sample findin |
| GET | /detector/{detectorId}/threatintelset | Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated |
| POST | /detector/{detectorId}/threatintelset | Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the |
| POST | /invitation/decline | Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs. |
| GET | /detector/{detectorId} | <p>Retrieves an Amazon GuardDuty detector specified by the detectorId.</p> <p>There might be regional differences because some data sources might not be availab |
| POST | /detector/{detectorId} | <p>Updates the Amazon GuardDuty detector specified by the detectorId.</p> <p>There might be regional differences because some data sources might not be availabl |
| DELETE | /detector/{detectorId} | Deletes an Amazon GuardDuty detector that is specified by the detector ID. |
| GET | /detector/{detectorId}/filter/{filterName} | Returns the details of the filter specified by the filter name. |
| POST | /detector/{detectorId}/filter/{filterName} | Updates the filter specified by the filter name. |
| DELETE | /detector/{detectorId}/filter/{filterName} | Deletes the filter specified by the filter name. |
| GET | /detector/{detectorId}/ipset/{ipSetId} | Retrieves the IPSet specified by the <code>ipSetId</code>. |
| POST | /detector/{detectorId}/ipset/{ipSetId} | Updates the IPSet specified by the IPSet ID. |
| DELETE | /detector/{detectorId}/ipset/{ipSetId} | Deletes the IPSet specified by the <code>ipSetId</code>. IPSets are called trusted IP lists in the console user interface. |
| POST | /invitation/delete | Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs. |
| POST | /detector/{detectorId}/member/delete | <p>Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.</p> <p>With <code>autoEnableOrganizationMemb |
| GET | /detector/{detectorId}/publishingDestination/{destinationId} | Returns information about the publishing destination specified by the provided <code>destinationId</code>. |
| POST | /detector/{detectorId}/publishingDestination/{destinationId} | Updates information about the publishing destination specified by the <code>destinationId</code>. |
| DELETE | /detector/{detectorId}/publishingDestination/{destinationId} | Deletes the publishing definition with the specified <code>destinationId</code>. |
| GET | /detector/{detectorId}/threatintelset/{threatIntelSetId} | Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID. |
| POST | /detector/{detectorId}/threatintelset/{threatIntelSetId} | Updates the ThreatIntelSet specified by the ThreatIntelSet ID. |
| DELETE | /detector/{detectorId}/threatintelset/{threatIntelSetId} | Deletes the ThreatIntelSet specified by the ThreatIntelSet ID. |
| POST | /detector/{detectorId}/malware-scans | <p>Returns 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 t |
| GET | /detector/{detectorId}/admin | <p>Returns information about the account selected as the delegated administrator for GuardDuty.</p> <p>There might be regional differences because some data sou |
| POST | /detector/{detectorId}/admin | <p>Configures the delegated administrator account with the provided values. You must provide the value for either <code>autoEnableOrganizationMembers</code> or |
| POST | /admin/disable | Disables an Amazon Web Services account within the Organization as the GuardDuty delegated administrator. |
| POST | /detector/{detectorId}/administrator/disassociate | <p>Disassociates the current GuardDuty member account from its administrator account.</p> <p>With <code>autoEnableOrganizationMembers</code> configuration for y |
| POST | /detector/{detectorId}/master/disassociatedeprecated | Disassociates the current GuardDuty member account from its administrator account. |
| POST | /detector/{detectorId}/member/disassociate | <p>Disassociates GuardDuty member accounts (to the current administrator account) specified by the account IDs.</p> <p>With <code>autoEnableOrganizationMembers< |
| POST | /admin/enable | Enables an Amazon Web Services account within the organization as the GuardDuty delegated administrator. |
| POST | /detector/{detectorId}/coverage/statistics | Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with th |
| POST | /detector/{detectorId}/findings/get | Describes Amazon GuardDuty findings specified by finding IDs. |
| POST | /detector/{detectorId}/findings/statistics | Lists Amazon GuardDuty findings statistics for the specified detector ID. |
| GET | /invitation/count | Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation. |
| GET | /detector/{detectorId}/malware-scan-settings | <p>Returns the details of the malware scan settings.</p> <p>There might be regional differences because some data sources might not be available in all the Amaz |
| POST | /detector/{detectorId}/malware-scan-settings | <p>Updates the malware scan settings.</p> <p>There might be regional differences because some data sources might not be available in all the Amazon Web Services |
| POST | /detector/{detectorId}/member/detector/get | <p>Describes which data sources are enabled for the member account's detector.</p> <p>There might be regional differences because some data sources might not be |
| POST | /detector/{detectorId}/member/get | Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs. |
| POST | /detector/{detectorId}/freeTrial/daysRemaining | Provides the number of days left for each data source used in the free trial period. |
| POST | /detector/{detectorId}/usage/statistics | Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources, the cost returned will |
| POST | /detector/{detectorId}/member/invite | Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the c |
| POST | /detector/{detectorId}/coverage | <p>Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member acco |
| POST | /detector/{detectorId}/findings | Lists Amazon GuardDuty findings for the specified detector ID. |
| GET | /invitation | Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account. |
| GET | /admin | Lists the accounts configured as GuardDuty delegated administrators. |
| GET | /tags/{resourceArn} | Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. |
| POST | /tags/{resourceArn} | Adds tags to a resource. |
| POST | /detector/{detectorId}/member/start | Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the <a hre |
| POST | /detector/{detectorId}/member/stop | <p>Stops GuardDuty monitoring for the specified member accounts. Use the <code>StartMonitoringMembers</code> operation to restart monitoring for those accounts. |
| POST | /detector/{detectorId}/findings/unarchive | Unarchives GuardDuty findings specified by the <code>findingIds</code>. |
| DELETE | /tags/{resourceArn}#tagKeys | Removes tags from a resource. |
| POST | /detector/{detectorId}/findings/feedback | Marks the specified GuardDuty findings as useful or not useful. |
| POST | /detector/{detectorId}/member/detector/update | <p>Contains information on member accounts to be updated.</p> <p>There might be regional differences because some data sources might not be available in all the |
Questions
Does the Amazon GuardDuty API need an API key?
Yes. The Amazon GuardDuty API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon GuardDuty API support HTTPS?
Yes, the Amazon GuardDuty API is served over HTTPS.
How many endpoints does the Amazon GuardDuty API have?
Its OpenAPI description lists 67 endpoints in version 2017-11-28. All of them are shown on this page.
What are alternatives to the Amazon GuardDuty API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).