Skip to content
Updawg

`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 }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

Request Bodyrequired

Section titled “Request Bodyrequired”
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
Examplegenerated
{
  "agent_auto_update": true,
  "audit_retention_days": 1,
  "eol_lead_days": [
    1
  ],
  "name": "example",
  "slug": "example",
  "stale_after_minutes": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

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
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
plan
required
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"
}

400

Section titled “400”

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
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 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
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

That slug is taken.

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"
}