From 53bb0d7c406dd332d7daaa2965ba0fb74ef5183e Mon Sep 17 00:00:00 2001 From: Copple <10214025+kiwicopple@users.noreply.github.com> Date: Sat, 13 Aug 2022 19:56:33 +0200 Subject: [PATCH] Adds some instructions to the API --- apps/reference/_api/intro.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/apps/reference/_api/intro.md b/apps/reference/_api/intro.md index d10d6bd02c3..052d25ef830 100644 --- a/apps/reference/_api/intro.md +++ b/apps/reference/_api/intro.md @@ -4,6 +4,28 @@ sidebar_position: 1 sidebar_label: Supabase API --- -# Supabase API +# Supabase API (Beta) -Some docs +The Supabase API allows you to manage your projects programmatically. + +## Status + +The API is currently in beta. It may have breaking changes. + +## Authentication + +All API requests require an `Authorization Bearer token`. +To generate or manage your API key, visit your [account](https://app.supabase.com/account/tokens) page. +Your API key carries the same privileges as your user account, so be sure to keep it secret. + +```bash +$ curl https://api.supabase.com/v1/projects \ +-H "Authorization: Bearer sbp_bdd0••••••••••••••••••••••••••••••••4f23" +``` + +All API requests must be authenticated and made over HTTPS. + +## Rate limits + +The API is currently subject to our fair-use policy. In the future, are likely to introduce rate limits. +All resources created via the API are subject to the pricing detailed on our [Pricing](https://supabase.com/pricing) pages. \ No newline at end of file