Skip to content

Update from code changes: migrate docs to urbackend.in domains #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yash-pouranik merged 1 commit into from
Sep 25, 2026
Merged

Update from code changes: migrate docs to urbackend.in domains #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions mintlify/docs/api-reference/auth/login.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The refresh token is issued alongside the access token and delivered differently
<CodeGroup>

```javascript fetch
const res = await fetch('https://api.ub.bitbros.in/api/userAuth/login', {
const res = await fetch('https://api.urbackend.in/api/userAuth/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand All @@ -80,7 +80,7 @@ const { accessToken, expiresIn, user } = await res.json();
```

```bash curl
curl -X POST "https://api.ub.bitbros.in/api/userAuth/login" \
curl -X POST "https://api.urbackend.in/api/userAuth/login" \
-H "Content-Type: application/json" \
-H "x-api-key: pk_live_YOUR_KEY" \
-c cookies.txt \
Expand Down
6 changes: 3 additions & 3 deletions mintlify/docs/api-reference/auth/logout.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Like the refresh endpoint, logout needs to read the current refresh token to kno
<CodeGroup>

```javascript Web (cookie)
await fetch('https://api.ub.bitbros.in/api/userAuth/logout', {
await fetch('https://api.urbackend.in/api/userAuth/logout', {
method: 'POST',
headers: {
'x-api-key': 'pk_live_YOUR_KEY'
Expand All @@ -39,7 +39,7 @@ await fetch('https://api.ub.bitbros.in/api/userAuth/logout', {
```

```javascript Mobile (header)
await fetch('https://api.ub.bitbros.in/api/userAuth/logout', {
await fetch('https://api.urbackend.in/api/userAuth/logout', {
method: 'POST',
headers: {
'x-api-key': 'pk_live_YOUR_KEY',
Expand All @@ -49,7 +49,7 @@ await fetch('https://api.ub.bitbros.in/api/userAuth/logout', {
```

```bash curl
curl -X POST "https://api.ub.bitbros.in/api/userAuth/logout" \
curl -X POST "https://api.urbackend.in/api/userAuth/logout" \
-H "x-api-key: pk_live_YOUR_KEY" \
-b cookies.txt
```
Expand Down
6 changes: 3 additions & 3 deletions mintlify/docs/api-reference/auth/me.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Returns the full profile of the currently signed-in user. The response never inc
<CodeGroup>

```javascript fetch
const res = await fetch('https://api.ub.bitbros.in/api/userAuth/me', {
const res = await fetch('https://api.urbackend.in/api/userAuth/me', {
headers: {
'x-api-key': 'pk_live_YOUR_KEY',
'Authorization': `Bearer ${accessToken}`
Expand All @@ -45,7 +45,7 @@ const user = await res.json();
```

```bash curl
curl "https://api.ub.bitbros.in/api/userAuth/me" \
curl "https://api.urbackend.in/api/userAuth/me" \
-H "x-api-key: pk_live_YOUR_KEY" \
-H "Authorization: Bearer ACCESS_TOKEN"
```
Expand Down Expand Up @@ -93,7 +93,7 @@ Returns a public-safe view of a user's profile. No authentication is required.
### Code Example

```javascript
const res = await fetch('https://api.ub.bitbros.in/api/userAuth/public/alice_dev', {
const res = await fetch('https://api.urbackend.in/api/userAuth/public/alice_dev', {
headers: {
'x-api-key': 'pk_live_YOUR_KEY'
}
Expand Down
4 changes: 2 additions & 2 deletions mintlify/docs/api-reference/auth/refresh-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Include the refresh token in the `x-refresh-token` header, and set `x-refresh-to

```javascript Web (cookie)
// Browser: credentials: 'include' sends the HTTP-only cookie automatically
const res = await fetch('https://api.ub.bitbros.in/api/userAuth/refresh-token', {
const res = await fetch('https://api.urbackend.in/api/userAuth/refresh-token', {
method: 'POST',
headers: {
'x-api-key': 'pk_live_YOUR_KEY'
Expand All @@ -58,7 +58,7 @@ const { accessToken: newAccessToken } = await res.json();

```javascript Mobile (header)
// Mobile / non-browser: pass the refresh token explicitly in a header
const res = await fetch('https://api.ub.bitbros.in/api/userAuth/refresh-token', {
const res = await fetch('https://api.urbackend.in/api/userAuth/refresh-token', {
method: 'POST',
headers: {
'x-api-key': 'pk_live_YOUR_KEY',
Expand Down
4 changes: 2 additions & 2 deletions mintlify/docs/api-reference/auth/signup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Creates a new user account and returns an access token. Any extra fields defined
<CodeGroup>

```javascript fetch
const res = await fetch('https://api.ub.bitbros.in/api/userAuth/signup', {
const res = await fetch('https://api.urbackend.in/api/userAuth/signup', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand All @@ -82,7 +82,7 @@ const { user, accessToken } = await res.json();
```

```bash curl
curl -X POST "https://api.ub.bitbros.in/api/userAuth/signup" \
curl -X POST "https://api.urbackend.in/api/userAuth/signup" \
-H "Content-Type: application/json" \
-H "x-api-key: pk_live_YOUR_KEY" \
-d '{
Expand Down
8 changes: 4 additions & 4 deletions mintlify/docs/api-reference/auth/social.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Before using these endpoints you need to configure the OAuth provider in your pr

1. Go to **Project Settings** and add your frontend URL as the **Site URL** (e.g., `https://myapp.com`).
2. Go to **Auth → Social Auth** and select GitHub or Google.
3. Copy the read-only **Callback URL** shown by urBackend (e.g., `https://api.ub.bitbros.in/api/userAuth/social/github/callback`).
3. Copy the read-only **Callback URL** shown by urBackend (e.g., `https://api.urbackend.in/api/userAuth/social/github/callback`).
4. Register that callback URL in the provider's OAuth app settings (GitHub: **Developer Settings → OAuth Apps**; Google: **Cloud Console → Credentials**).
5. Paste the provider's **Client ID** and **Client Secret** into urBackend and enable the provider.

Expand All @@ -36,11 +36,11 @@ Redirects the user's browser to the provider login page. Because this is a brows
```javascript
// Redirect the user to start the OAuth flow
window.location.href =
'https://api.ub.bitbros.in/api/userAuth/social/github/start?x-api-key=pk_live_YOUR_KEY';
'https://api.urbackend.in/api/userAuth/social/github/start?x-api-key=pk_live_YOUR_KEY';

// Or for Google:
window.location.href =
'https://api.ub.bitbros.in/api/userAuth/social/google/start?x-api-key=pk_live_YOUR_KEY';
'https://api.urbackend.in/api/userAuth/social/google/start?x-api-key=pk_live_YOUR_KEY';
```

After the user authenticates with the provider, urBackend redirects them to:
Expand Down Expand Up @@ -146,7 +146,7 @@ function AuthCallback() {
}

// Exchange rtCode for refresh token
const res = await fetch('https://api.ub.bitbros.in/api/userAuth/social/exchange', {
const res = await fetch('https://api.urbackend.in/api/userAuth/social/exchange', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand Down
4 changes: 2 additions & 2 deletions mintlify/docs/api-reference/data/aggregate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If Row-Level Security (RLS) is enabled, your backend automatically injects a `$m

```javascript fetch
const res = await fetch(
'https://api.ub.bitbros.in/api/data/orders/aggregate',
'https://api.urbackend.in/api/data/orders/aggregate',
{
method: 'POST',
headers: {
Expand All @@ -78,7 +78,7 @@ const { success, data } = await res.json();
```

```bash curl
curl -X POST "https://api.ub.bitbros.in/api/data/orders/aggregate?include_deleted=false" \
curl -X POST "https://api.urbackend.in/api/data/orders/aggregate?include_deleted=false" \
-H "Content-Type: application/json" \
-H "x-api-key: pk_live_YOUR_KEY" \
-d '{
Expand Down
8 changes: 4 additions & 4 deletions mintlify/docs/api-reference/data/delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ When using `pk_live` with RLS enabled, urBackend compares the existing document'
const docId = '64fd1234abcd5678ef901234';

const res = await fetch(
`https://api.ub.bitbros.in/api/data/posts/${docId}`,
`https://api.urbackend.in/api/data/posts/${docId}`,
{
method: 'DELETE',
headers: {
Expand All @@ -71,7 +71,7 @@ const { success, data, message } = await res.json();
const docId = '64fd1234abcd5678ef901234';

const res = await fetch(
`https://api.ub.bitbros.in/api/data/posts/${docId}`,
`https://api.urbackend.in/api/data/posts/${docId}`,
{
method: 'DELETE',
headers: {
Expand All @@ -83,12 +83,12 @@ const res = await fetch(
```

```bash curl
curl -X DELETE "https://api.ub.bitbros.in/api/data/posts/64fd1234abcd5678ef901234" \
curl -X DELETE "https://api.urbackend.in/api/data/posts/64fd1234abcd5678ef901234" \
-H "x-api-key: sk_live_YOUR_SECRET_KEY"
```

```bash curl (permanent)
curl -X DELETE "https://api.ub.bitbros.in/api/data/posts/64fd1234abcd5678ef901234?permanent=true" \
curl -X DELETE "https://api.urbackend.in/api/data/posts/64fd1234abcd5678ef901234?permanent=true" \
-H "x-api-key: sk_live_YOUR_SECRET_KEY"
```

Expand Down
6 changes: 3 additions & 3 deletions mintlify/docs/api-reference/data/get-all.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ const params = new URLSearchParams({
});

const res = await fetch(
`https://api.ub.bitbros.in/api/data/posts?${params}`,
`https://api.urbackend.in/api/data/posts?${params}`,
{
headers: {
'x-api-key': 'pk_live_YOUR_KEY'
Expand All @@ -113,12 +113,12 @@ const { data } = await res.json();
```

```bash curl
curl "https://api.ub.bitbros.in/api/data/posts?page=1&limit=10&sort=-createdAt&status=published&include_deleted=true" \
curl "https://api.urbackend.in/api/data/posts?page=1&limit=10&sort=-createdAt&status=published&include_deleted=true" \
-H "x-api-key: pk_live_YOUR_KEY"
```

```javascript Private collection (RLS)
const res = await fetch('https://api.ub.bitbros.in/api/data/notes', {
const res = await fetch('https://api.urbackend.in/api/data/notes', {
headers: {
'x-api-key': 'pk_live_YOUR_KEY',
'Authorization': `Bearer ${accessToken}` // Required for private-mode collections
Expand Down
4 changes: 2 additions & 2 deletions mintlify/docs/api-reference/data/get-one.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The endpoint returns the document object directly.
const docId = '64fd1234abcd5678ef901234';

const res = await fetch(
`https://api.ub.bitbros.in/api/data/posts/${docId}?include_deleted=true`,
`https://api.urbackend.in/api/data/posts/${docId}?include_deleted=true`,
{
headers: {
'x-api-key': 'pk_live_YOUR_KEY'
Expand All @@ -76,7 +76,7 @@ const doc = await res.json();
```

```bash curl
curl "https://api.ub.bitbros.in/api/data/posts/64fd1234abcd5678ef901234?include_deleted=true" \
curl "https://api.urbackend.in/api/data/posts/64fd1234abcd5678ef901234?include_deleted=true" \
-H "x-api-key: pk_live_YOUR_KEY"
```

Expand Down
6 changes: 3 additions & 3 deletions mintlify/docs/api-reference/data/insert.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The endpoint returns the created document object directly.

```javascript sk_live (server-side)
// Use sk_live from your server — never expose it in frontend code
const res = await fetch('https://api.ub.bitbros.in/api/data/posts', {
const res = await fetch('https://api.urbackend.in/api/data/posts', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand All @@ -83,7 +83,7 @@ const doc = await res.json();
```javascript pk_live + RLS (client-side)
// Use pk_live + user JWT when collection has RLS enabled
// userId is auto-injected from the JWT — no need to include it
const res = await fetch('https://api.ub.bitbros.in/api/data/posts', {
const res = await fetch('https://api.urbackend.in/api/data/posts', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand All @@ -101,7 +101,7 @@ const doc = await res.json();
```

```bash curl (sk_live)
curl -X POST "https://api.ub.bitbros.in/api/data/posts" \
curl -X POST "https://api.urbackend.in/api/data/posts" \
-H "Content-Type: application/json" \
-H "x-api-key: sk_live_YOUR_SECRET_KEY" \
-d '{
Expand Down
8 changes: 4 additions & 4 deletions mintlify/docs/api-reference/data/update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ When using `pk_live` with RLS enabled, urBackend fetches the existing document a
const postId = '64fd1234abcd5678ef901234';

const res = await fetch(
`https://api.ub.bitbros.in/api/data/posts/${postId}`,
`https://api.urbackend.in/api/data/posts/${postId}`,
{
method: 'PUT',
headers: {
Expand All @@ -87,7 +87,7 @@ console.log('Updated document:', data);
const postId = '64fd1234abcd5678ef901234';

const res = await fetch(
`https://api.ub.bitbros.in/api/data/posts/${postId}`,
`https://api.urbackend.in/api/data/posts/${postId}`,
{
method: 'PATCH',
headers: {
Expand All @@ -108,7 +108,7 @@ console.log('Updated document:', data);
const postId = '64fd1234abcd5678ef901234';

const res = await fetch(
`https://api.ub.bitbros.in/api/data/posts/${postId}`,
`https://api.urbackend.in/api/data/posts/${postId}`,
{
method: 'PATCH',
headers: {
Expand All @@ -128,7 +128,7 @@ console.log('Updated document:', data);
```

```bash curl
curl -X PUT "https://api.ub.bitbros.in/api/data/posts/64fd1234abcd5678ef901234" \
curl -X PUT "https://api.urbackend.in/api/data/posts/64fd1234abcd5678ef901234" \
-H "Content-Type: application/json" \
-H "x-api-key: sk_live_YOUR_SECRET_KEY" \
-d '{"title": "Updated title", "meta.views": 105}'
Expand Down
10 changes: 5 additions & 5 deletions mintlify/docs/api-reference/mail/send.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ For URL values, prefer escaped placeholders like `{{appUrl}}`. URL-like variable

<Steps>
<Step title="Get your Secret Key">
Log in to the [urBackend Dashboard](https://urbackend.bitbros.in/dashboard), create a new project, and copy your **Secret Key** (`sk_live_...`) or you can get it from rotating it from project overview page.
Log in to the [urBackend Dashboard](https://app.urbackend.in), create a new project, and copy your **Secret Key** (`sk_live_...`) or you can get it from rotating it from project overview page.
</Step>
<Step title="Copy the Code">
Copy your preferred language snippet from below. Use **Direct Mode** if you just want to send a quick HTML/Text email without setting up templates or use welcome template for fast test.
Expand All @@ -102,7 +102,7 @@ For URL values, prefer escaped placeholders like `{{appUrl}}`. URL-like variable
<CodeGroup>

```javascript fetch (template mode)
const res = await fetch('https://api.ub.bitbros.in/api/mail/send', {
const res = await fetch('https://api.urbackend.in/api/mail/send', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand All @@ -121,7 +121,7 @@ const res = await fetch('https://api.ub.bitbros.in/api/mail/send', {
```

```javascript fetch (direct mode)
const res = await fetch('https://api.ub.bitbros.in/api/mail/send', {
const res = await fetch('https://api.urbackend.in/api/mail/send', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand Down Expand Up @@ -157,7 +157,7 @@ public class Main {
""";

HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.ub.bitbros.in/api/mail/send"))
.uri(URI.create("https://api.urbackend.in/api/mail/send"))
.header("Content-Type", "application/json")
.header("x-api-key", "sk_live_YOUR_SECRET_KEY")
.POST(HttpRequest.BodyPublishers.ofString(jsonBody))
Expand Down Expand Up @@ -187,7 +187,7 @@ public class Main {
""";

HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.ub.bitbros.in/api/mail/send"))
.uri(URI.create("https://api.urbackend.in/api/mail/send"))
.header("Content-Type", "application/json")
.header("x-api-key", "sk_live_YOUR_SECRET_KEY")
.POST(HttpRequest.BodyPublishers.ofString(jsonBody))
Expand Down
17 changes: 16 additions & 1 deletion mintlify/docs/api-reference/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,24 @@ description: "Base URL, authentication, response format, and a full quick-refere
All API requests are made to:

```
https://api.ub.bitbros.in
https://api.urbackend.in
```

<Warning>
urBackend moved to new domains. The previous `bitbros.in` hosts stay live until 30 October 2026. After that date they are deprecated. Update your apps to use the new hosts before then.

| Service | New host | Previous host |
| :--- | :--- | :--- |
| Public API (SDK and user auth) | `https://api.urbackend.in` | `https://api.ub.bitbros.in` |
| Dashboard | `https://app.urbackend.in` | `https://urbackend.bitbros.in` |
| Dashboard API | `https://platform-api.urbackend.in` | `https://dashboard-api.ub.bitbros.in` |
| Landing site | `https://urbackend.in` | — |
</Warning>

<Note>
The official SDKs may still default to the previous API host. To target the new host, pass `baseUrl: 'https://api.urbackend.in'` when you create the client.
</Note>

## Authentication

Every request must include an `x-api-key` header. urBackend issues two keys per project with different trust levels:
Expand Down
4 changes: 2 additions & 2 deletions mintlify/docs/api-reference/storage/delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Permanently removes a file from storage. You must provide the `path` value that
<CodeGroup>

```javascript fetch
const res = await fetch('https://api.ub.bitbros.in/api/storage/file', {
const res = await fetch('https://api.urbackend.in/api/storage/file', {
method: 'DELETE',
headers: {
'Content-Type': 'application/json',
Expand All @@ -51,7 +51,7 @@ const { success, message } = await res.json();
```

```bash curl
curl -X DELETE "https://api.ub.bitbros.in/api/storage/file" \
curl -X DELETE "https://api.urbackend.in/api/storage/file" \
-H "Content-Type: application/json" \
-H "x-api-key: pk_live_YOUR_KEY" \
-d '{"path": "PROJECT_ID/image.png"}'
Expand Down
Loading
Loading