Skip to content
Updawg

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

GET
/v1/orgs/{org}
curl --request GET \
  --url https://api.updawg.net/v1/orgs/example

Any member may read it. There is no ReadFleet-less role.

All of the work happened in the [Member] extractor, which is the point: the organization is not looked up here because it cannot be reached without having been resolved and authorized already.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

Responses

Section titled “Responses”

200

Section titled “200”

The organization.

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

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

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

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