Skip to content
Updawg

`POST /v1/orgs/{org}/api-tokens`.

POST
/v1/orgs/{org}/api-tokens
curl --request POST \
  --url https://api.updawg.net/v1/orgs/example/api-tokens \
  --header 'Content-Type: application/json' \
  --data '{ "expires_at": "2026-04-15T12:00:00Z", "name": "example", "scopes": [ "example" ] }'

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
expires_at

When it stops working. Absent never expires.

string | null format: date-time
name
required

What it is for — “terraform”, “CI”. Shown in the list, since the value never is again.

string
scopes
required

What it may do: any of read, comment, approve, rollout, jobs, policy, groups, hosts, enrollment, audit, integrations, as far as your role allows.

Array<string>
Examplegenerated
{
  "expires_at": "2026-04-15T12:00:00Z",
  "name": "example",
  "scopes": [
    "example"
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

Issued. ⚠️ token is in this response and never again.

Media typeapplication/json

The one response that carries the value.

object
created_at
required
string format: date-time
created_by
required

The usr_… it acts as.

string
created_by_email
string | null
expires_at
string | null format: date-time
id
required

atk_…. The record, not the credential.

string
last_used_at

To the minute: written at most once a minute.

string | null format: date-time
name
required
string
prefix
required

The value’s first characters, to recognise it by: upd_AbCdEfGh.

string
revoked_at
string | null format: date-time
scopes
required
Array<string>
token
required

⚠️ Shown once. upd_…, sent as Authorization: Bearer upd_….

string
Examplegenerated
{
  "created_at": "2026-04-15T12:00:00Z",
  "created_by": "example",
  "created_by_email": "example",
  "expires_at": "2026-04-15T12:00:00Z",
  "id": "example",
  "last_used_at": "2026-04-15T12:00:00Z",
  "name": "example",
  "prefix": "example",
  "revoked_at": "2026-04-15T12:00:00Z",
  "scopes": [
    "example"
  ],
  "token": "example"
}

400

Section titled “400”

No name, no scopes, a scope that is not one or that your role cannot grant, or an expiry in the past.

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, or asked with an API token. Or the plan is not Business or Enterprise: plan-required.

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