Skip to content

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

PATCH
/v1/orgs/{org}
curl --request PATCH \
--url https://api.updawg.net/v1/orgs/example \
--header 'Content-Type: application/json' \
--data '{ "agent_auto_update": true, "audit_retention_days": 1, "eol_lead_days": [ 1 ], "name": "example", "slug": "example", "stale_after_minutes": 1 }'
org
required
string

Organization slug.

Media typeapplication/json
object
agent_auto_update

Keep agents on the stable channel without anybody approving each update (DAWG-46). When stable moves, an agent update is opened and approved on your authority, for every host behind it whose agent.toml permits self_update. It stays yours: if you stop administering the organization, nothing more is signed until somebody turns it on again.

boolean | null
audit_retention_days

Days to keep the audit log, 7 up to what the plan keeps (audit_retention_max_days), or null for the plan’s whole window (DAWG-160). Owner only. Shortening it deletes the older entries at the next nightly run, and nothing brings them back.

integer | null format: int32
eol_lead_days

Days before a release’s support ends to raise release.eol, each 1 to 730, at most six (DAWG-70). Stored longest first without repeats. Empty leaves only the alert when support has ended.

Array<integer> | null
name

Absent means “leave it alone”, which is not the same as an empty string.

string | null
slug
string | null
stale_after_minutes

Minutes without a check-in before a host is marked stale, 5 to 10,080 (DAWG-62). Set it above your longest expected outage — a reboot, a maintenance window — or every one of them marks hosts stale.

integer | null format: int32

Example generated

{
"agent_auto_update": true,
"audit_retention_days": 1,
"eol_lead_days": [
1
],
"name": "example",
"slug": "example",
"stale_after_minutes": 1
}

Updated.

Media typeapplication/json
object
agent_auto_update
required

Whether agents are kept on the stable channel automatically (DAWG-46).

boolean
audit_retention_days

Days the audit log is kept if fewer than the plan keeps, or null for the plan’s whole window (DAWG-160).

integer | null format: int32
audit_retention_max_days
required

The most audit_retention_days may be on this plan.

integer format: int32
changes_paused_from

When changes stop for it, a week after over_allowance_since: from then hosts keep reporting but nothing is installed or rebooted, and approving is refused, until it is back within Free or on a paid plan.

string | null format: date-time
eol_lead_days
required

Days before a release’s support ends to raise release.eol, longest first (DAWG-70). 180, 90 and 30 unless somebody changed them.

Array<integer>
id
required
string
name
required
string
over_allowance_since

When this Free organization was first seen over the Free allowance — more hosts than Free allows, or its owner’s second Free organization — or null when it is within it or on a paid plan (DAWG-295). Checked nightly.

string | null format: date-time
plan
required
string
region
required

Where its data lives, eu or us (DAWG-159). Fixed at creation.

string
role
required

The caller’s role, on every representation of an organization.

The portal needs it to decide what to render, and fetching it from GET /me instead would mean the two can disagree after somebody’s role changes in another tab.

string
Allowed values: viewer operator admin owner
slug
required
string
stale_after_minutes
required

Minutes without a check-in before a host is marked stale (DAWG-62). 5 to 10,080; 30 unless somebody changed it.

integer format: int32

Example

{
"role": "viewer"
}

A name or slug that will not do, or a stale threshold, EOL lead time or audit retention out of range.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

Not permitted for this role.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

No such organization, or not yours — one answer for both.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

That slug is taken.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

The organization’s data is in another region (wrong-region, DAWG-159). detail names that region’s API; send the request there.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

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

Example generated

{
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}