Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

GET/api/v1/whoami

Any valid key%!(EXTRA string=)MCP tool: whoami operationId whoami

The calling key

Kind, project, scopes and expiry of the key the request carries. Any valid key may call it.

Request body

None.

Responses

200

The calling key

  • WhoamiResponse object · all fields required
  • expires_atstring · date-time | null

    When the key stops working; null: never.

  • key_idstring · uuid

    The key’s id: what revoking it takes.

    example 01900000-0000-7000-8000-000000000001

  • The kind of an API key.

    • admin
    • project
  • namestring

    The name its owner gave it.

    example ops

  • project_idstring · uuid | null

    The key’s project; null for an admin key.

  • scopesarray of Scope

    What the key may do. An admin key has every scope, and may manage projects and admin keys besides.

401

No key (key_missing), not a valid key (key_invalid), a revoked key (key_revoked) or an expired one (key_expired)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

HeaderTypeDescription
Retry-AfterintegerSeconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)