Skip to main content
PATCH
/
groups
/
{group_id}
Update group
curl --request PATCH \
  --url https://api.dnsradar.dev/groups/{group_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "Premium Accounts",
  "slug": "premium-accounts"
}
'
{
  "id": "grp_abc123...",
  "slug": "production-servers",
  "name": "Production Servers",
  "is_default": true,
  "monitors": 42,
  "webhooks": 5
}
You can update a group’s name and/or slug.
You can pass only the fields you want to update; other fields will remain unchanged.
Changing the slug will affect how you reference the group in API calls.

Authorizations

X-Api-Key
string
header
required

API key used to authenticate yourself on DNSRadar. Obtain your API key from your DNSRadar dashboard.

Path Parameters

group_id
string
required

Group ID (e.g: grp_abc123...)

Body

application/json
name
string
Maximum string length: 250
Example:

"Premium Accounts"

slug
string

URL-friendly identifier for the group

Example:

"premium-accounts"

Response

Group updated

Group for organizing monitors

id
string

Group identifier with 'grp_' prefix

Example:

"grp_abc123..."

slug
string

URL-friendly identifier

Example:

"production-servers"

name
string

Display name

Example:

"Production Servers"

is_default
boolean

Whether this is the default group

monitors
integer

Number of monitors in this group

Example:

42

webhooks
integer

Number of webhooks in this group

Example:

5