# Xata

## Docs

- [Bulk delete API Keys for an organization](https://xata.io/docs/api-reference/api-keys/bulk-delete-api-keys-for-an-organization.md): Delete multiple API keys in a single request.
- [Bulk delete API Keys for the authenticated user](https://xata.io/docs/api-reference/api-keys/bulk-delete-api-keys-for-the-authenticated-user.md): Delete multiple API keys in a single request.
- [Create a User API Key](https://xata.io/docs/api-reference/api-keys/create-a-user-api-key.md): Create a new API key for the authenticated user.
- [Create an Organization API Key](https://xata.io/docs/api-reference/api-keys/create-an-organization-api-key.md): Create a new API key for an organization.
- [List API Keys for an organization](https://xata.io/docs/api-reference/api-keys/list-api-keys-for-an-organization.md): Retrieve a list of API keys for a specific organization.
- [List API Keys for the authenticated user](https://xata.io/docs/api-reference/api-keys/list-api-keys-for-the-authenticated-user.md): Retrieve a list of API keys for the authenticated user.
- [Create a new branch](https://xata.io/docs/api-reference/branches/create-a-new-branch.md): Creates a new branch within the specified project. Branches can be created from scratch or derived from an existing parent branch.
- [Delete a branch](https://xata.io/docs/api-reference/branches/delete-a-branch.md): Permanently deletes a specific branch by its ID and all associated data. This action cannot be undone.
- [Get branch details](https://xata.io/docs/api-reference/branches/get-branch-details.md): Retrieves detailed information about a specific branch by its ID, including status, connection string, and configuration.
- [Get PostgreSQL configuration details](https://xata.io/docs/api-reference/branches/get-postgresql-configuration-details.md): Retrieves detailed information about the current PostgreSQL configuration parameters for a branch, including parameter types, descriptions, acceptable ranges, default values, and current values.
- [List all branches](https://xata.io/docs/api-reference/branches/list-all-branches.md): Retrieves a list of all branches within the specified project, including their metadata, region, and access settings.
- [Retrieve branch credentials](https://xata.io/docs/api-reference/branches/retrieve-branch-credentials.md)
- [Retrieve branch metrics](https://xata.io/docs/api-reference/branches/retrieve-branch-metrics.md)
- [Update branch details](https://xata.io/docs/api-reference/branches/update-branch-details.md): Updates the configuration of a specific branch by its ID, such as changing its name, description, or resource allocation.
- [Execute SQL query](https://xata.io/docs/api-reference/gateway/execute-sql-query.md): Execute a single SQL query or a batch of queries against a PostgreSQL branch.
- [WebSocket wire protocol proxy](https://xata.io/docs/api-reference/gateway/websocket-wire-protocol-proxy.md): Upgrade to a WebSocket connection that proxies the PostgreSQL wire protocol. The client sends and receives PostgreSQL protocol messages over binary WebSocket frames.
- [Create a new organization](https://xata.io/docs/api-reference/organizations/create-a-new-organization.md): Creates a new organization with the authenticated user as its single owner.
- [Delete an invitation](https://xata.io/docs/api-reference/organizations/delete-an-invitation.md): Permanently delete an invitation record.
- [Delete an organization](https://xata.io/docs/api-reference/organizations/delete-an-organization.md): [Not implemented yet] Permanently delete an organization. This action cannot be undone.
- [Get details of a specific invitation](https://xata.io/docs/api-reference/organizations/get-details-of-a-specific-invitation.md): Retrieve detailed information about a specific invitation by its ID.
- [Get list of organizations](https://xata.io/docs/api-reference/organizations/get-list-of-organizations.md): Retrieve the list of all organizations the authenticated user belongs to, including their IDs and names. This endpoint allows users to view all organizations they have access to.
- [Get organization details](https://xata.io/docs/api-reference/organizations/get-organization-details.md): Retrieve detailed information about a specific organization by its ID.
- [List invitations for an organization](https://xata.io/docs/api-reference/organizations/list-invitations-for-an-organization.md): Retrieve all invitations for an organization with optional filtering by status, email, and name.
- [List members of an organization](https://xata.io/docs/api-reference/organizations/list-members-of-an-organization.md)
- [Remove a member from an organization](https://xata.io/docs/api-reference/organizations/remove-a-member-from-an-organization.md)
- [Resend an invitation](https://xata.io/docs/api-reference/organizations/resend-an-invitation.md): Resend a pending invitation with a fresh expiration time.
- [Send an invitation to join an organization](https://xata.io/docs/api-reference/organizations/send-an-invitation-to-join-an-organization.md): Send an invitation email to a user to join an organization.
- [Update organization details](https://xata.io/docs/api-reference/organizations/update-organization-details.md): Update information for an existing organization, such as its name.
- [Create a new project](https://xata.io/docs/api-reference/projects/create-a-new-project.md): Creates a new project within the specified organization. Projects are containers for database branches and resources.
- [Delete a project](https://xata.io/docs/api-reference/projects/delete-a-project.md): Permanently deletes a specific project by its ID and all associated resources including branches and databases. This action cannot be undone.
- [Get available images](https://xata.io/docs/api-reference/projects/get-available-images.md): Retrieves a list of all images for the specified organization and region
- [Get available instance types](https://xata.io/docs/api-reference/projects/get-available-instance-types.md): Retrieves a list of all instance types for the specified organization and region
- [Get available regions](https://xata.io/docs/api-reference/projects/get-available-regions.md): Retrieves a list of all regions where new branches can be deployed for the specified organization.
- [Get project details](https://xata.io/docs/api-reference/projects/get-project-details.md): Retrieves detailed information about a specific project by its ID within the specified organization.
- [Get project resource limits](https://xata.io/docs/api-reference/projects/get-project-resource-limits.md): Retrieves the default resource limits for projects in the specified organization, including maximum instances, storage, and allowed regions.
- [List all projects](https://xata.io/docs/api-reference/projects/list-all-projects.md): Retrieves a list of all projects within the specified organization that the authenticated user has access to.
- [Update project details](https://xata.io/docs/api-reference/projects/update-project-details.md): Updates the details of a specific project by its ID, such as changing its name.
- [Merge Readiness](https://xata.io/docs/automations/ga-check.md): GitHub Actions workflow for validating main branch status and migration readiness
- [Scheduled Clone](https://xata.io/docs/automations/ga-clone.md): GitHub Actions workflow for cloning databases on a schedule or on-demand
- [Create Branch](https://xata.io/docs/automations/ga-pr.md): GitHub Actions workflow for creating and managing development branches for pull requests
- [Scheduled Clone](https://xata.io/docs/automations/kubernetes-clone.md): Sample Kubernetes cron job to periodically copy the data from production to your staging system.
- [Changelog](https://xata.io/docs/changelog.md): Stay up to date with the latest Xata features, fixes and changes
- [auth](https://xata.io/docs/cli/auth.md): Commands for authenticating with Xata
- [branch](https://xata.io/docs/cli/branch.md): Commands for managing Xata database branches
- [checkout](https://xata.io/docs/cli/checkout.md): Checkout a branch
- [clone](https://xata.io/docs/cli/clone.md): Commands for managing database streaming (logical replication) operations
- [completions](https://xata.io/docs/cli/completions.md): Commands for managing shell completions for the Xata CLI
- [init](https://xata.io/docs/cli/init.md): Command for initializing a Xata project
- [keys](https://xata.io/docs/cli/keys.md): Commands for managing API keys
- [organization](https://xata.io/docs/cli/organization.md): Commands for managing Xata organizations
- [project](https://xata.io/docs/cli/project.md): Commands for managing Xata projects
- [roll](https://xata.io/docs/cli/roll.md): Commands for managing database migrations
- [status](https://xata.io/docs/cli/status.md): Command for checking Xata CLI status
- [stream](https://xata.io/docs/cli/stream.md): Commands for managing logical streaming replication operations
- [upgrade](https://xata.io/docs/cli/upgrade.md): Command for upgrading the Xata CLI
- [version](https://xata.io/docs/cli/version.md): Command for checking Xata CLI and pgroll version
- [Data Anonymization](https://xata.io/docs/core-concepts/anonymization.md): Sensitive data anonymization and masking for PostgreSQL
- [Instant Branching](https://xata.io/docs/core-concepts/branching.md): Copy-on-Write branching system for PostgreSQL databases.
- [Deployment Models](https://xata.io/docs/core-concepts/deployment.md): The various ways you can deploy Xata, whether for staging/dev or production, hosted in our cloud or in your cloud account.
- [Scale to Zero](https://xata.io/docs/core-concepts/scale-to-zero.md): Minimize costs by hibernating inactive database branches
- [Schema Changes](https://xata.io/docs/core-concepts/schema-changes.md): Zero-downtime schema migrations with automatic rollback support
- [Serverless Proxy](https://xata.io/docs/core-concepts/serverless-proxy.md): Connect to your Xata database via HTTP and WebSocket connections for serverless and edge environments.
- [AWS Aurora](https://xata.io/docs/migrations/aws-aurora.md): Learn how to migrate your AWS Aurora PostgreSQL database to Xata using xata clone
- [AWS RDS](https://xata.io/docs/migrations/aws-rds.md): Learn how to migrate your AWS RDS PostgreSQL database to Xata using xata clone
- [Azure Database](https://xata.io/docs/migrations/azure.md): Learn how to migrate your Azure Database for PostgreSQL to Xata using xata clone
- [GCP Cloud SQL](https://xata.io/docs/migrations/gcp-cloudsql.md): Learn how to migrate your GCP Cloud SQL PostgreSQL database to Xata using xata clone
- [Neon](https://xata.io/docs/migrations/neon.md): Learn how to migrate your Neon PostgreSQL database to Xata using xata clone
- [Self-Hosted PostgreSQL](https://xata.io/docs/migrations/self-hosted.md): Learn how to migrate your self-hosted PostgreSQL database to Xata using xata clone.
- [Supabase](https://xata.io/docs/migrations/supabase.md): Learn how to migrate your Supabase PostgreSQL database to Xata using xata clone
- [Observability](https://xata.io/docs/opensource/pgstream/docs/Observability.md)
- [Architecture](https://xata.io/docs/opensource/pgstream/docs/architecture.md)
- [AWS](https://xata.io/docs/opensource/pgstream/docs/aws.md)
- [CLI](https://xata.io/docs/opensource/pgstream/docs/cli.md)
- [Configuration](https://xata.io/docs/opensource/pgstream/docs/configuration.md)
- [GCP CloudSQL](https://xata.io/docs/opensource/pgstream/docs/gcp_cloudsql.md)
- [Neon](https://xata.io/docs/opensource/pgstream/docs/neon.md)
- [Privileges](https://xata.io/docs/opensource/pgstream/docs/privileges.md)
- [v1.0.0](https://xata.io/docs/opensource/pgstream/docs/releases/v1.0.0.md)
- [Snapshots](https://xata.io/docs/opensource/pgstream/docs/snapshots.md)
- [Transformers](https://xata.io/docs/opensource/pgstream/docs/transformers.md)
- [Replication using Kafka](https://xata.io/docs/opensource/pgstream/docs/tutorials/postgres_kafka.md)
- [PostgreSQL snapshots](https://xata.io/docs/opensource/pgstream/docs/tutorials/postgres_snapshot.md)
- [Replication to OpenSearch](https://xata.io/docs/opensource/pgstream/docs/tutorials/postgres_to_opensearch.md)
- [Replication to PostgreSQL](https://xata.io/docs/opensource/pgstream/docs/tutorials/postgres_to_postgres.md)
- [Replication to webhooks](https://xata.io/docs/opensource/pgstream/docs/tutorials/postgres_to_webhooks.md)
- [PostgreSQL anonymization](https://xata.io/docs/opensource/pgstream/docs/tutorials/postgres_transformer.md)
- [Xata](https://xata.io/docs/opensource/pgstream/docs/xata.md)
- [Overview](https://xata.io/docs/opensource/pgstream/overview.md): Postgres replication with DDL changes
- [Xata Documentation](https://xata.io/docs/overview.md)
- [Account Management](https://xata.io/docs/platform/account.md): Manage your account settings, profile, and authentication preferences
- [API Keys](https://xata.io/docs/platform/api-key.md): Generate and manage API keys for secure access to your Xata database
- [Branches](https://xata.io/docs/platform/branch.md): Create isolated database environments for development, testing, and staging
- [Compute](https://xata.io/docs/platform/compute.md): Configure scale-to-zero and hibernation options for projects and branches
- [Extensions](https://xata.io/docs/platform/extensions.md): All extensions listed below are currently available for PostgreSQL 14, 15, 16, 17, and 18. These extensions provide additional functionality to enhance your database, from spatial data processing to text search and monitoring tools.
- [Metrics](https://xata.io/docs/platform/metrics.md): Monitor your database performance across instances with real-time metrics
- [Migrations](https://xata.io/docs/platform/migrations.md): Zero-downtime schema migrations with automatic rollback support
- [Organizations](https://xata.io/docs/platform/organization.md): Collaborate with your team in a shared organization
- [Projects](https://xata.io/docs/platform/project.md): Create and manage projects that contain your database branches
- [Queries](https://xata.io/docs/platform/queries.md): Execute and manage database queries across your branches
- [Schemas](https://xata.io/docs/platform/schemas.md): Design, manage, and optimize your database schema structure and relationships
- [Quickstart](https://xata.io/docs/quickstart.md): Quickstart guide for Xata's PostgreSQL platform
- [Use Xata with Drizzle](https://xata.io/docs/quickstarts/drizzle.md): Learn how to connect your Drizzle ORM project to a Xata PostgreSQL database.
- [Use Xata with Railway](https://xata.io/docs/quickstarts/railway.md): Learn how to connect your Railway project with a Xata PostgreSQL database.
- [Create Staging Replica](https://xata.io/docs/tutorials/create-staging-replica.md): Use Xata's clone and branching features to create a safe, anonymized staging environment.
- [Make Schema Changes](https://xata.io/docs/tutorials/schema-change.md): Learn how to safely apply and roll back schema changes in Xata using the CLI.
- [Create Streaming Replica](https://xata.io/docs/tutorials/streaming-replication.md): Use Xata's streaming replication to keep your database continuously synchronized with real-time changes.

## OpenAPI Specs

- [openapi](https://api.xata.tech/openapi.json)


Built with [Mintlify](https://mintlify.com).