Skip to content
Updawg

`POST /v1/orgs/{org}/signing-keys/retire`.

POST
/v1/orgs/{org}/signing-keys/retire
curl --request POST \
  --url https://api.updawg.net/v1/orgs/example/signing-keys/retire \
  --header 'Content-Type: application/json' \
  --data '{ "key": "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
key

The sk_… of a key still retiring: the one before a rotation (DAWG-309), Updawg’s after a hand-over to your own, or an earlier one of yours (DAWG-293).

string | null

Example generated

{
  "key": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Retired. No job is signed with it again, and hosts refuse anything it signed once they next renew — which they do within minutes of a rotation. A host that has not renewed since holds no key that can sign its jobs until it does: check each key’s hosts_pinned first. After a hand-over, Updawg is never asked to sign for this organization again.

Media typeapplication/json
object
key
required

The key retired.

string

Example generated

{
  "key": "example"
}

400

Section titled “400”

key is missing or not a signing key id.

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

401

Section titled “401”

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

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

Example generated

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

404

Section titled “404”

No such organization or key, 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"
}

409

Section titled “409”

Not a key still retiring while another is active: the active key, or one already retired.

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

421

Section titled “421”

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

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

Example generated

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