Skip to content
Updawg

`PATCH /v1/orgs/{org}/groups/{group_id}`.

PATCH
/v1/orgs/{org}/groups/{group_id}
curl --request PATCH \
  --url https://api.updawg.net/v1/orgs/example/groups/example \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "label_selector": "example", "name": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

group_id
required
string

The grp_… id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Every field optional. An absent field is left alone; null clears description or label_selector.

object
description
string | null
label_selector
object | null
name
string | null
Examplegenerated
{
  "description": "example",
  "label_selector": "example",
  "name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Changed. A rename lists the policies that named the old name.

Media typeapplication/json
object
group
required
object
created_at
required
string format: date-time
description
string | null
id
required

grp_….

string
label_selector
object | null
name
required
string
resolved_hosts
required

Every host it resolves to, static or by label, each counted once. Decommissioned hosts are in no group.

integer format: int64
static_hosts
required

Hosts put in the group by hand. Decommissioned hosts are not counted.

integer format: int64
policies_naming_old_name
required

Live policies whose selector named the group’s old name, and so now match nothing of it. A policy selects a group by name. Empty unless the name changed.

Array<string>
Examplegenerated
{
  "group": {
    "created_at": "2026-04-15T12:00:00Z",
    "description": "example",
    "id": "example",
    "label_selector": "example",
    "name": "example",
    "resolved_hosts": 1,
    "static_hosts": 1
  },
  "policies_naming_old_name": [
    "example"
  ]
}

400

Section titled “400”

An empty name, or a selector that is empty or has an empty key.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “403”

Not permitted for this role.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

No such group here.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

A group with that name exists.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}