Skip to content

`POST /v1/orgs`.

POST
/v1/orgs
curl --request POST \
--url https://api.updawg.net/v1/orgs \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "region": "eu", "slug": "example" }'

The creator is the owner, written in the same transaction as the organization — otherwise there is an organization nobody can administer and which does not appear in its own creator’s GET /v1/me.

Media typeapplication/json
object
name
required
string
region

Where its data will live, eu or us (DAWG-159). Fixed once created. This API’s own region when not given; a region it does not serve is refused.

string | null

Example

eu
slug

Optional: derived from the name when it is not given.

string | null

Created. The caller becomes its owner.

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 region this API does not serve.

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

Refused: no CSRF token or not this session’s, or 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"
}

That slug is taken (slug-taken), or the caller already owns an organization on Free (organization-limit): one Free organization per person, so move that one to a paid plan first.

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