POST

/detector/{detectorId}/ipset

http://guardduty.{region}.amazonaws.com/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 communication with Amazon Web Services infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.

Access Token Required: API Key

Path Parameters

detectorIdstringrequired

The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

Body Params

namestringrequired

The user-friendly name to identify the IPSet. Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

tagsobject

The tags to be added to a new IP set resource.

formatstringrequired

The format of the file that contains the IPSet.

activatebooleanrequired

A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

locationstringrequired

The URI of the file that contains the IPSet.

clientTokenstring

The idempotency token for the create request.

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/{detectorId}/ipset' \
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}