REST API overview

Xata uses HTTP-based APIs for data management and collaboration, ensuring standardization, security, and compatibility with various client apps. Adherence to RESTful principles ensures predictable and consistent API structures for evolvability without disrupting existing applications.

Note, Xata can support no-code or low-code data ingestion through integrations with tools like Zapier and Airbyte.

The API methods define the actions that can be performed on resources. See our API reference docs for more information.

HTTP Method	Description	Read or Write	CRUD Equivalent
GET	Retrieve data or information from a resource.	Read	Read
POST	Create a new resource or initiate specific actions.	Write	Create
PATCH	Make partial modifications to an existing resource.	Write	Update (partial)
PUT	Replace an existing resource or create if not present.	Write	Update (full)
DELETE	Remove a resource or data from a collection.	Write	Delete

The responses listed below are standardized and can be applied to any API, including the Xata API. These response status codes adhere to the standards defined in RFC 2616 and RFC 6585 for web APIs.

Status code	Meaning	Description
200	OK	The request was successful, and the server provides the requested data.
201	Created	The request was successful, and a new resource was created as a result.
204	No content	The request was successful, but there is no additional data to return in the response body.
400	Bad request	The request contains invalid data or parameters. The client should modify and resend the request.
401	Unauthorized	Authentication is required, or the provided credentials are invalid or expired.
403	Forbidden	The client does not have permission to access the requested resource.
404	Not found	The requested resource could not be found on the server.
405	Method not allowed	The HTTP method used in the request is not allowed for the requested resource.
409	Conflict	There is a conflict with the current state of the resource or a resource version mismatch.
429	Too many requests	The user or client exceeded request rate limits.
5xx	Internal server error/ service unavailable	An unexpected error occurred on the server, and the request could not be fulfilled. The server is temporarily unable to handle the request, typically due to maintenance or high load.