mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-18 13:02:11 +03:00
3cd656f3c7
* check db connection in healthz endpoint * use Spock.text to automatically set Content-Type * update docs
128 lines
3.8 KiB
ReStructuredText
128 lines
3.8 KiB
ReStructuredText
.. _api-reference:
|
|
|
|
API Reference
|
|
=============
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
Available APIs
|
|
--------------
|
|
|
|
+-----------------+----------------------------------------+------------------+
|
|
| API | Endpoint | Access |
|
|
+=================+========================================+==================+
|
|
| GraphQL | :ref:`/v1/graphql <graphql_api>` | Permission rules |
|
|
+-----------------+----------------------------------------+------------------+
|
|
| Legacy GraphQL | :ref:`/v1alpha1/graphql <graphql_api>` | Permission rules |
|
|
+-----------------+----------------------------------------+------------------+
|
|
| Schema/Metadata | :ref:`/v1/query <schema_metadata_api>` | Admin only |
|
|
+-----------------+----------------------------------------+------------------+
|
|
| Version | :ref:`/v1/version <version_api>` | Public |
|
|
+-----------------+----------------------------------------+------------------+
|
|
| Health | :ref:`/healthz <health_api>` | Public |
|
|
+-----------------+----------------------------------------+------------------+
|
|
| PG Dump | :ref:`/v1alpha1/pg_dump <pg_dump_api>` | Admin only |
|
|
+-----------------+----------------------------------------+------------------+
|
|
| Config | :ref:`/v1alpha1/config <config_api>` | Admin only |
|
|
+-----------------+----------------------------------------+------------------+
|
|
|
|
.. _graphql_api:
|
|
|
|
GraphQL API
|
|
^^^^^^^^^^^
|
|
|
|
All GraphQL requests for queries, subscriptions and mutations are made to the GraphQL API.
|
|
|
|
See details at :doc:`graphql-api/index`.
|
|
|
|
.. _schema_metadata_api:
|
|
|
|
Schema / metadata API
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Hasura exposes a schema / metadata API for managing metadata for permissions/relationships or for directly
|
|
executing SQL on the underlying Postgres.
|
|
|
|
This is primarily intended to be used as an ``admin`` API to manage the Hasura schema and metadata.
|
|
|
|
See details at :doc:`schema-metadata-api/index`.
|
|
|
|
.. _version_api:
|
|
|
|
Version API
|
|
^^^^^^^^^^^
|
|
|
|
A ``GET`` request to the public ``/v1/version`` endpoint responds with the current server version
|
|
in JSON format:
|
|
|
|
.. code-block:: js
|
|
|
|
{"version": "v1.0.0-alpha01"}
|
|
|
|
.. _health_api:
|
|
|
|
Health check API
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
A ``GET`` request to the public ``/healthz`` endpoint will respond with the following:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Server condition
|
|
- HTTP Status
|
|
- Message
|
|
* - All healthy
|
|
- 200
|
|
- OK
|
|
* - Serving requests but some metadata objects are inconsistent/not-available
|
|
- 200
|
|
- WARN: inconsistent objects in schema
|
|
* - Unhealthy
|
|
- 500
|
|
- ERROR
|
|
|
|
If there are metadata inconsistencies, you should use the console or use the `get_inconsistent_metadata <schema-metadata-api/manage-metadata.html#get-inconsistent-metadata>`_ API to find out what the inconsistent objects are.
|
|
|
|
|
|
.. _pg_dump_api:
|
|
|
|
pg_dump API
|
|
^^^^^^^^^^^
|
|
|
|
The ``/v1alpha1/pg_dump`` is an admin-only endpoint that can be used to execute
|
|
``pg_dump`` on the Postgres instance connected to Hasura. The ``pg_dump`` CLI
|
|
tool's argument can be passed as a POST request body to the API and the response
|
|
is sent back to the client.
|
|
|
|
See details at :doc:`pgdump`.
|
|
|
|
.. _config_api:
|
|
|
|
Config API
|
|
^^^^^^^^^^
|
|
|
|
``v1alpha1/config`` is an admin-only endpoint to get the current server
|
|
configuration.
|
|
|
|
See details at :doc:`config`.
|
|
|
|
Supported PostgreSQL types
|
|
--------------------------
|
|
You can refer to the following to know about all PostgreSQL types supported by the Hasura GraphQL engine:
|
|
|
|
- :doc:`Supported PostgreSQL types <postgresql-types>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:hidden:
|
|
|
|
GraphQL API <graphql-api/index>
|
|
Schema / Metadata APIs <schema-metadata-api/index>
|
|
PG Dump API <pgdump>
|
|
Config API <config>
|
|
Supported PostgreSQL types <postgresql-types>
|