# UFW API Documentation

> Canonical index of UFW's human-readable API reference.

## API overview
- [API reference](https://ufw.dev/docs/reference/api): base URL, authentication, scopes, response codes, and the product directory.
- [OpenAPI specification](https://ufw.dev/openapi.json): machine-readable API contract.

## Endpoints
### Podcasts

#### Podcasts

- [GET /v1/podcasts](https://ufw.dev/docs/reference/api/podcasts/list): List podcasts.
- [POST /v1/podcasts](https://ufw.dev/docs/reference/api/podcasts/create): Create a podcast.
- [GET /v1/podcasts/{podcastId}](https://ufw.dev/docs/reference/api/podcasts/retrieve): Get a podcast.
- [PATCH /v1/podcasts/{podcastId}](https://ufw.dev/docs/reference/api/podcasts/update): Replace podcast details.
- [DELETE /v1/podcasts/{podcastId}](https://ufw.dev/docs/reference/api/podcasts/delete): Delete a podcast.
- [GET /v1/podcasts/{podcastId}/validation](https://ufw.dev/docs/reference/api/podcasts/validation): Validate a podcast.
- [GET /v1/podcasts/{podcastId}/analytics](https://ufw.dev/docs/reference/api/podcasts/analytics): Get podcast analytics.
- [GET /v1/podcasts/feeds/{podcastId}](https://ufw.dev/docs/reference/api/podcasts/feeds/retrieve): Get the public podcast feed.

#### Seasons

- [POST /v1/podcasts/{podcastId}/seasons](https://ufw.dev/docs/reference/api/podcasts/seasons/create): Create a season.
- [PATCH /v1/podcasts/{podcastId}/seasons/{seasonId}](https://ufw.dev/docs/reference/api/podcasts/seasons/update): Update a season.
- [DELETE /v1/podcasts/{podcastId}/seasons/{seasonId}](https://ufw.dev/docs/reference/api/podcasts/seasons/delete): Delete a season.

#### Episodes

- [POST /v1/podcasts/{podcastId}/episodes](https://ufw.dev/docs/reference/api/podcasts/episodes/create): Create an episode.
- [PATCH /v1/podcasts/{podcastId}/episodes/{episodeId}](https://ufw.dev/docs/reference/api/podcasts/episodes/update): Replace episode details.
- [DELETE /v1/podcasts/{podcastId}/episodes/{episodeId}](https://ufw.dev/docs/reference/api/podcasts/episodes/delete): Delete an episode.

#### Artwork uploads

- [POST /v1/podcasts/{podcastId}/artwork/presign](https://ufw.dev/docs/reference/api/podcasts/artwork/presign): Create an artwork upload URL.
- [POST /v1/podcasts/{podcastId}/artwork/complete](https://ufw.dev/docs/reference/api/podcasts/artwork/complete): Complete an artwork upload.

#### Audio uploads

- [POST /v1/podcasts/{podcastId}/episodes/{episodeId}/master/presign](https://ufw.dev/docs/reference/api/podcasts/episodes/master/presign): Create an audio upload URL.
- [POST /v1/podcasts/{podcastId}/episodes/{episodeId}/master/complete](https://ufw.dev/docs/reference/api/podcasts/episodes/master/complete): Complete an audio upload.

#### Publishing

- [POST /v1/podcasts/{podcastId}/episodes/{episodeId}/publish](https://ufw.dev/docs/reference/api/podcasts/episodes/publish): Publish an episode.
- [POST /v1/podcasts/{podcastId}/episodes/{episodeId}/unpublish](https://ufw.dev/docs/reference/api/podcasts/episodes/unpublish): Unpublish an episode.
- [POST /v1/podcasts/{podcastId}/episodes/{episodeId}/schedule](https://ufw.dev/docs/reference/api/podcasts/episodes/schedule): Schedule an episode.
- [POST /v1/podcasts/{podcastId}/episodes/{episodeId}/retry](https://ufw.dev/docs/reference/api/podcasts/episodes/retry): Retry an episode.

### Organizations

- [GET /v1/account/organizations/{organizationId}](https://ufw.dev/docs/reference/api/organizations/retrieve): Get an organization.
- [PATCH /v1/organizations/{organizationId}](https://ufw.dev/docs/reference/api/organizations/update): Update an organization.
- [DELETE /v1/organizations/{organizationId}](https://ufw.dev/docs/reference/api/organizations/delete): Delete an organization.
- [POST /v1/account/organizations/{organizationId}/logo/presign](https://ufw.dev/docs/reference/api/organizations/logo/presign): Create a logo upload URL.
- [POST /v1/account/organizations/{organizationId}/logo/complete](https://ufw.dev/docs/reference/api/organizations/logo/complete): Complete a logo upload.

### Cloud

#### Cloud

- [GET /v1/cloud/overview](https://ufw.dev/docs/reference/api/cloud/overview): Get Cloud overview.
- [GET /v1/cloud/storage](https://ufw.dev/docs/reference/api/cloud/storage): Get Cloud storage.
- [GET /v1/cloud/billing](https://ufw.dev/docs/reference/api/cloud/billing): Get Cloud billing.
- [GET /v1/cloud/orders](https://ufw.dev/docs/reference/api/cloud/orders/list): Get Cloud orders.
- [POST /v1/cloud/orders](https://ufw.dev/docs/reference/api/cloud/orders/create): Create a Cloud order.

#### Billing

- [POST /v1/cloud/pro/checkout](https://ufw.dev/docs/reference/api/cloud/pro/checkout): Checkout a Pro subscription.
- [POST /v1/cloud/pro/portal](https://ufw.dev/docs/reference/api/cloud/pro/portal): Portal a Pro subscription.
- [POST /v1/cloud/pro/cancel](https://ufw.dev/docs/reference/api/cloud/pro/cancel): Cancel a Pro subscription.
- [POST /v1/cloud/pro/resume](https://ufw.dev/docs/reference/api/cloud/pro/resume): Resume a Pro subscription.
- [POST /v1/cloud/pro/refund](https://ufw.dev/docs/reference/api/cloud/pro/refund): Refund a Pro subscription.

### Identity

#### OAuth 2.1

- [GET /oauth2/v2.0/authorize](https://ufw.dev/docs/reference/api/identity/authorize): Start authorization.
- [POST /oauth2/v2.0/token](https://ufw.dev/docs/reference/api/identity/token): Exchange a code or refresh token.
- [GET /oauth2/v2.0/userinfo](https://ufw.dev/docs/reference/api/identity/userinfo): Get OpenID user information.
- [POST /oauth2/v2.0/userinfo](https://ufw.dev/docs/reference/api/identity/userinfo-post): Get OpenID user information.
- [GET /oauth2/v2.0/logout](https://ufw.dev/docs/reference/api/identity/logout): End an OpenID session.

#### Discovery

- [GET /oauth2/v2.0/.well-known/openid-configuration](https://ufw.dev/docs/reference/api/identity/openid-configuration): Get OpenID Connect metadata.
- [GET /oauth2/v2.0/.well-known/oauth-authorization-server](https://ufw.dev/docs/reference/api/identity/authorization-server-metadata): Get OAuth authorization server metadata.
- [GET /oauth2/v2.0/discovery/keys](https://ufw.dev/docs/reference/api/identity/discovery/keys): Get signing keys.
- [GET /oauth2/v2.0/jwks](https://ufw.dev/docs/reference/api/identity/jwks): Get JSON Web Key Set.

### Developer

- [GET /v1/developer/applications/{client_id}](https://ufw.dev/docs/reference/api/developer/applications/retrieve): Get public application details.
- [GET /v1/account/clients](https://ufw.dev/docs/reference/api/developer/clients/list): List OAuth clients.
- [GET /v1/account/clients/{client_id}](https://ufw.dev/docs/reference/api/developer/clients/retrieve): Get an OAuth client.
- [GET /v1/account/clients/{client_id}/activity](https://ufw.dev/docs/reference/api/developer/clients/activity): Get OAuth client activity.
- [POST /v1/developer/clients](https://ufw.dev/docs/reference/api/developer/clients/create): Register an OAuth client.
- [PATCH /v1/developer/clients/{client_id}](https://ufw.dev/docs/reference/api/developer/clients/update): Replace an OAuth client.
- [DELETE /v1/developer/clients/{client_id}](https://ufw.dev/docs/reference/api/developer/clients/delete): Delete an OAuth client.
- [POST /v1/developer/clients/{client_id}/secret](https://ufw.dev/docs/reference/api/developer/clients/secret/rotate): Rotate the client secret.
- [POST /v1/developer/clients/{client_id}/icon/presign](https://ufw.dev/docs/reference/api/developer/clients/icon/presign): Create a client-icon upload URL.
- [POST /v1/developer/clients/{client_id}/icon/complete](https://ufw.dev/docs/reference/api/developer/clients/icon/complete): Complete a client-icon upload.

### GraphQL

- [POST /v1/graphql](https://ufw.dev/docs/reference/api/graphql/execute): Execute a GraphQL operation.

### System

- [GET /](https://ufw.dev/docs/reference/api/system/info): API service information.
- [GET /healthz](https://ufw.dev/docs/reference/api/system/healthz): Check process health.
- [GET /readyz](https://ufw.dev/docs/reference/api/system/readyz): Check service readiness.
- [GET /v1/meta](https://ufw.dev/docs/reference/api/system/meta): Get API metadata.

### Account

#### Account

- [GET /v1/account/me](https://ufw.dev/docs/reference/api/account/me): Get the current account.
- [POST /v1/account/profile](https://ufw.dev/docs/reference/api/account/profile/update): Update the account profile.
- [POST /v1/account/profile-picture/presign](https://ufw.dev/docs/reference/api/account/profile-picture/presign): Create a profile-picture upload URL.
- [POST /v1/account/profile-picture/complete](https://ufw.dev/docs/reference/api/account/profile-picture/complete): Complete a profile-picture upload.
- [GET /v1/account/deletion/request](https://ufw.dev/docs/reference/api/account/deletion/status): Get account-deletion status.
- [POST /v1/account/deletion/request](https://ufw.dev/docs/reference/api/account/deletion/request): Request account deletion.

#### Emails

- [GET /v1/account/emails](https://ufw.dev/docs/reference/api/account/emails/list): List email addresses.
- [POST /v1/account/emails](https://ufw.dev/docs/reference/api/account/emails/create): Add an email address.
- [DELETE /v1/account/emails/{emailId}](https://ufw.dev/docs/reference/api/account/emails/delete): Remove an email address.
- [POST /v1/account/emails/{emailId}/verify](https://ufw.dev/docs/reference/api/account/emails/verify): Verify an email address.

#### Security

- [GET /v1/account/factors](https://ufw.dev/docs/reference/api/account/factors/list): List security factors.
- [POST /v1/account/factors](https://ufw.dev/docs/reference/api/account/factors/create): Add a security factor.
- [POST /v1/account/password](https://ufw.dev/docs/reference/api/account/password/change): Change the account password.
- [POST /v1/account/totp/start](https://ufw.dev/docs/reference/api/account/totp/start): Totp Start.
- [POST /v1/account/totp/verify](https://ufw.dev/docs/reference/api/account/totp/verify): Totp Verify.
- [POST /v1/account/passkeys/options](https://ufw.dev/docs/reference/api/account/passkeys/options): Passkeys Options.
- [POST /v1/account/passkeys/verify](https://ufw.dev/docs/reference/api/account/passkeys/verify): Passkeys Verify.

#### Sessions

- [GET /v1/account/sessions](https://ufw.dev/docs/reference/api/account/sessions/list): List sessions.
- [POST /v1/account/sessions](https://ufw.dev/docs/reference/api/account/sessions/revoke): Revoke sessions.