POST

/detector

http://guardduty.{region}.amazonaws.com/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 detector in each Region where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default.</p> <p>There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>

Access Token Required: API Key

Body Params

tagsobject

The tags to be added to a new detector resource.

enablebooleanrequired

A Boolean value that specifies whether the detector is to be enabled.

featuresarray

A list of features that will be configured for the detector.

clientTokenstring

The idempotency token for the create request.

dataSourcesobject

Contains information about which data sources are enabled.

findingPublishingFrequencystring

A value that specifies how frequently updated findings are exported.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://guardduty.{region}.amazonaws.com/detector' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}