diff --git a/.github/workflows/sync-management-api-docs.yml b/.github/workflows/sync-management-api-docs.yml
index 35a61a768a..f366c47288 100644
--- a/.github/workflows/sync-management-api-docs.yml
+++ b/.github/workflows/sync-management-api-docs.yml
@@ -31,24 +31,20 @@ jobs:
- name: Install dependencies
run: pnpm install
- - name: Fetch OpenAPI spec
- working-directory: apps/docs
- run: pnpm fetch-openapi
-
- - name: Generate docs
+ - name: Generate docs and Postman collection
working-directory: apps/docs
run: pnpm run generate:management-api-docs
- name: Check for changes
id: changes
run: |
- if [[ -z "$(git status --porcelain --untracked-files=all -- apps/docs/content/docs/management-api/)" ]]; then
+ if [[ -z "$(git status --porcelain --untracked-files=all -- apps/docs/content/docs/management-api/ apps/docs/public/prisma-management-api.postman_collection.json apps/docs/vercel.json)" ]]; then
echo "changed=false" >> $GITHUB_OUTPUT
- echo "No MDX changes detected"
+ echo "No changes detected"
else
echo "changed=true" >> $GITHUB_OUTPUT
- echo "MDX changes detected:"
- git status --short -- apps/docs/content/docs/management-api/
+ echo "Changes detected:"
+ git status --short -- apps/docs/content/docs/management-api/ apps/docs/public/prisma-management-api.postman_collection.json apps/docs/vercel.json
fi
- name: Commit and push
@@ -56,7 +52,7 @@ jobs:
run: |
git config user.email "prismabots@gmail.com"
git config user.name "Prismo"
- git add apps/docs/content/docs/management-api/
+ git add apps/docs/content/docs/management-api/ apps/docs/public/prisma-management-api.postman_collection.json apps/docs/vercel.json
git commit -m "chore(docs): sync management API documentation"
git push "https://x-access-token:${{ secrets.BOT_TOKEN_DOCS_COMMIT }}@github.com/${{ github.repository }}.git" HEAD:${{ github.ref_name }}
diff --git a/apps/docs/content/docs/management-api/api-clients.mdx b/apps/docs/content/docs/management-api/api-clients.mdx
index 923bb7df21..217d9cca73 100644
--- a/apps/docs/content/docs/management-api/api-clients.mdx
+++ b/apps/docs/content/docs/management-api/api-clients.mdx
@@ -8,6 +8,8 @@ metaDescription: Learn how to use the Management API with API Clients
This guide shows you how to configure popular API clients to work with the Management API using OAuth 2.0 authentication.
+Download the Postman collection to import all endpoints with OAuth2 auth pre-configured. Compatible with Postman, Yaak, Insomnia, and other clients that support the Postman Collection v2.1 format.
+
## Postman
Postman is a popular API client with testing, collaboration, and automation features for working with REST APIs.
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-branches-by-branch-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-branches-by-branch-id.mdx
deleted file mode 100644
index 757b1b7a13..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-branches-by-branch-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Soft-delete a branch
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Soft-deletes a Branch (sets deletedAt). Refuses if the Branch is the Project''s current default (FR4) or has live members (FR3).'
-full: true
-_openapi:
- method: DELETE
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Soft-deletes a Branch (sets deletedAt). Refuses if the Branch is the Project's current default (FR4) or has live members (FR3).
- path: '/v1/branches/{branchId}'
-url: '/management-api/endpoints/[experimental]/delete-branches-by-branch-id'
-metaTitle: 'DELETE /v1/branches/{branchId} | Soft-delete a branch'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Soft-deletes a Branch (sets deletedAt). Refuses if the Branch is the Project''s current default (FR4) or has live members (FR3).'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Soft-deletes a Branch (sets deletedAt). Refuses if the Branch is the Project's current default (FR4) or has live members (FR3).
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-compute-services-by-compute-service-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-compute-services-by-compute-service-id.mdx
deleted file mode 100644
index 7ab940e39c..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-compute-services-by-compute-service-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Delete compute service
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Deletes a compute service. All compute versions under the service must already be stopped or deleted.'
-full: true
-_openapi:
- method: DELETE
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Deletes a compute service. All compute versions under the service must already be stopped or deleted.
- path: '/v1/compute-services/{computeServiceId}'
-url: '/management-api/endpoints/[experimental]/delete-compute-services-by-compute-service-id'
-metaTitle: 'DELETE /v1/compute-services/{computeServiceId} | Delete compute service'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Deletes a compute service. All compute versions under the service must already be stopped or deleted.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Deletes a compute service. All compute versions under the service must already be stopped or deleted.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-compute-services-versions-by-version-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-compute-services-versions-by-version-id.mdx
deleted file mode 100644
index 5b09919281..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-compute-services-versions-by-version-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Delete compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
-full: true
-_openapi:
- method: DELETE
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.
- path: '/v1/compute-services/versions/{versionId}'
-url: '/management-api/endpoints/[experimental]/delete-compute-services-versions-by-version-id'
-metaTitle: 'DELETE /v1/compute-services/versions/{versionId} | Delete compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-environment-variables-by-env-var-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-environment-variables-by-env-var-id.mdx
deleted file mode 100644
index be603200e0..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-environment-variables-by-env-var-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Delete an environment variable
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Removes an environment variable. A second delete of the same variable returns 404.'
-full: true
-_openapi:
- method: DELETE
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Removes an environment variable. A second delete of the same variable returns 404.
- path: '/v1/environment-variables/{envVarId}'
-url: '/management-api/endpoints/[experimental]/delete-environment-variables-by-env-var-id'
-metaTitle: 'DELETE /v1/environment-variables/{envVarId} | Delete an environment variable'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Removes an environment variable. A second delete of the same variable returns 404.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Removes an environment variable. A second delete of the same variable returns 404.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-versions-by-version-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-versions-by-version-id.mdx
deleted file mode 100644
index 331fe8dd45..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/delete-versions-by-version-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Delete compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
-full: true
-_openapi:
- method: DELETE
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.
- path: '/v1/versions/{versionId}'
-url: '/management-api/endpoints/[experimental]/delete-versions-by-version-id'
-metaTitle: 'DELETE /v1/versions/{versionId} | Delete compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-branches-by-branch-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-branches-by-branch-id.mdx
deleted file mode 100644
index d907e78848..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-branches-by-branch-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Get a branch
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a single Branch by ID. Member resources are not inlined — list them via /v1/databases?branchId= and /v1/compute-services?branchId=.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns a single Branch by ID. Member resources are not inlined — list them via /v1/databases?branchId= and /v1/compute-services?branchId=.
- path: '/v1/branches/{branchId}'
-url: '/management-api/endpoints/[experimental]/get-branches-by-branch-id'
-metaTitle: 'GET /v1/branches/{branchId} | Get a branch'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a single Branch by ID. Member resources are not inlined — list them via /v1/databases?branchId= and /v1/compute-services?branchId=.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns a single Branch by ID. Member resources are not inlined — list them via /v1/databases?branchId= and /v1/compute-services?branchId=.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id-versions.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id-versions.mdx
deleted file mode 100644
index a1bae85dc5..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id-versions.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: List compute versions
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions belonging to a compute service, ordered by creation time (newest first). Supports cursor-based pagination.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns all compute versions belonging to a compute service, ordered by creation time (newest first). Supports cursor-based pagination.
- path: '/v1/compute-services/{computeServiceId}/versions'
-url: '/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id-versions'
-metaTitle: 'GET /v1/compute-services/{computeServiceId}/versions | List compute versions'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions belonging to a compute service, ordered by creation time (newest first). Supports cursor-based pagination.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns all compute versions belonging to a compute service, ordered by creation time (newest first). Supports cursor-based pagination.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id.mdx
deleted file mode 100644
index a1ceee61c2..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Get compute service
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute service by ID, including its region and latest version reference.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns a compute service by ID, including its region and latest version reference.
- path: '/v1/compute-services/{computeServiceId}'
-url: '/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id'
-metaTitle: 'GET /v1/compute-services/{computeServiceId} | Get compute service'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute service by ID, including its region and latest version reference.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns a compute service by ID, including its region and latest version reference.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id-logs.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id-logs.mdx
deleted file mode 100644
index a33a63e333..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id-logs.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Stream compute version logs via WebSocket
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Upgrades to a WebSocket connection that streams log output for the specified compute version. Each message is a JSON object with `type: "log"` (log text + byte metadata) or `type: "terminal"` (end-of-segment signal with reconnect cursor). The stream ends after 10 minutes; reconnect with the `cursor` query parameter to continue.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Upgrades to a WebSocket connection that streams log output for the specified compute version. Each message is a JSON object with `type: "log"` (log text + byte metadata) or `type: "terminal"` (end-of-segment signal with reconnect cursor). The stream ends after 10 minutes; reconnect with the `cursor` query parameter to continue.
- path: '/v1/compute-services/versions/{versionId}/logs'
-url: '/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id-logs'
-metaTitle: 'GET /v1/compute-services/versions/{versionId}/logs | Stream compute version logs via WebSocket'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Upgrades to a WebSocket connection that streams log output for the specified compute version. Each message is a JSON object with `type: "log"` (log text + byte metadata) or `type: "terminal"` (end-of-segment signal with reconnect cursor). The stream ends after 10 minutes; reconnect with the `cursor` query parameter to continue.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Upgrades to a WebSocket connection that streams log output for the specified compute version. Each message is a JSON object with `type: "log"` (log text + byte metadata) or `type: "terminal"` (end-of-segment signal with reconnect cursor). The stream ends after 10 minutes; reconnect with the `cursor` query parameter to continue.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id.mdx
deleted file mode 100644
index 4b204bd0b7..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Get compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns a compute version by ID, including its current status derived from the underlying VM state.
- path: '/v1/compute-services/versions/{versionId}'
-url: '/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id'
-metaTitle: 'GET /v1/compute-services/versions/{versionId} | Get compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns a compute version by ID, including its current status derived from the underlying VM state.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services.mdx
deleted file mode 100644
index 57d2f3cc6a..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-compute-services.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: List compute services
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns all compute services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.
- path: /v1/compute-services
-url: '/management-api/endpoints/[experimental]/get-compute-services'
-metaTitle: GET /v1/compute-services | List compute services
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns all compute services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-environment-variables-by-env-var-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-environment-variables-by-env-var-id.mdx
deleted file mode 100644
index 813ef18981..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-environment-variables-by-env-var-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Get an environment variable
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a single environment variable''s metadata. The value is not returned.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns a single environment variable's metadata. The value is not returned.
- path: '/v1/environment-variables/{envVarId}'
-url: '/management-api/endpoints/[experimental]/get-environment-variables-by-env-var-id'
-metaTitle: 'GET /v1/environment-variables/{envVarId} | Get an environment variable'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a single environment variable''s metadata. The value is not returned.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns a single environment variable's metadata. The value is not returned.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-environment-variables.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-environment-variables.mdx
deleted file mode 100644
index 70085ed1e8..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-environment-variables.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: List environment variables
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a paginated list of environment variables. All filters are optional; combine `projectId`, `class`, and `key` to look up a specific variable by name.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns a paginated list of environment variables. All filters are optional; combine `projectId`, `class`, and `key` to look up a specific variable by name.
- path: /v1/environment-variables
-url: '/management-api/endpoints/[experimental]/get-environment-variables'
-metaTitle: GET /v1/environment-variables | List environment variables
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a paginated list of environment variables. All filters are optional; combine `projectId`, `class`, and `key` to look up a specific variable by name.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns a paginated list of environment variables. All filters are optional; combine `projectId`, `class`, and `key` to look up a specific variable by name.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-projects-by-project-id-branches.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-projects-by-project-id-branches.mdx
deleted file mode 100644
index e4bbe3ff58..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-projects-by-project-id-branches.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: List branches in a project
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns the live Branches of a Project. Supports two mutually exclusive filters: ?gitName= (exact match — at most one row), ?gitNameContains= (case-sensitive substring). Soft-deleted Branches are not returned. Ordered by createdAt ascending.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns the live Branches of a Project. Supports two mutually exclusive filters: ?gitName= (exact match — at most one row), ?gitNameContains= (case-sensitive substring). Soft-deleted Branches are not returned. Ordered by createdAt ascending.
- path: '/v1/projects/{projectId}/branches'
-url: '/management-api/endpoints/[experimental]/get-projects-by-project-id-branches'
-metaTitle: 'GET /v1/projects/{projectId}/branches | List branches in a project'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns the live Branches of a Project. Supports two mutually exclusive filters: ?gitName= (exact match — at most one row), ?gitNameContains= (case-sensitive substring). Soft-deleted Branches are not returned. Ordered by createdAt ascending.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns the live Branches of a Project. Supports two mutually exclusive filters: ?gitName= (exact match — at most one row), ?gitNameContains= (case-sensitive substring). Soft-deleted Branches are not returned. Ordered by createdAt ascending.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-projects-by-project-id-compute-services.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-projects-by-project-id-compute-services.mdx
deleted file mode 100644
index db07a93ba1..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-projects-by-project-id-compute-services.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: List compute services for a project
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services belonging to a project, ordered by creation time (oldest first). Supports cursor-based pagination.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns all compute services belonging to a project, ordered by creation time (oldest first). Supports cursor-based pagination.
- path: '/v1/projects/{projectId}/compute-services'
-url: '/management-api/endpoints/[experimental]/get-projects-by-project-id-compute-services'
-metaTitle: 'GET /v1/projects/{projectId}/compute-services | List compute services for a project'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services belonging to a project, ordered by creation time (oldest first). Supports cursor-based pagination.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns all compute services belonging to a project, ordered by creation time (oldest first). Supports cursor-based pagination.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-versions-by-version-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-versions-by-version-id.mdx
deleted file mode 100644
index 55e8a1815b..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-versions-by-version-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Get compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns a compute version by ID, including its current status derived from the underlying VM state.
- path: '/v1/versions/{versionId}'
-url: '/management-api/endpoints/[experimental]/get-versions-by-version-id'
-metaTitle: 'GET /v1/versions/{versionId} | Get compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns a compute version by ID, including its current status derived from the underlying VM state.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-versions.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/get-versions.mdx
deleted file mode 100644
index 7fc3c5a8c1..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/get-versions.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: List compute versions
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions the token has access to, ordered by creation time (newest first). Optionally filter by compute service ID. Supports cursor-based pagination.'
-full: true
-_openapi:
- method: GET
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Returns all compute versions the token has access to, ordered by creation time (newest first). Optionally filter by compute service ID. Supports cursor-based pagination.
- path: /v1/versions
-url: '/management-api/endpoints/[experimental]/get-versions'
-metaTitle: GET /v1/versions | List compute versions
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions the token has access to, ordered by creation time (newest first). Optionally filter by compute service ID. Supports cursor-based pagination.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Returns all compute versions the token has access to, ordered by creation time (newest first). Optionally filter by compute service ID. Supports cursor-based pagination.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-branches-by-branch-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-branches-by-branch-id.mdx
deleted file mode 100644
index a9c8eb6a1c..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-branches-by-branch-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Update a branch
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Promotes a Branch to be the Project''s default. Only isDefault is mutable — gitName rename is rejected (FR13 — gitName is a stable, externally-typed identifier).'
-full: true
-_openapi:
- method: PATCH
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Promotes a Branch to be the Project's default. Only isDefault is mutable — gitName rename is rejected (FR13 — gitName is a stable, externally-typed identifier).
- path: '/v1/branches/{branchId}'
-url: '/management-api/endpoints/[experimental]/patch-branches-by-branch-id'
-metaTitle: 'PATCH /v1/branches/{branchId} | Update a branch'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Promotes a Branch to be the Project''s default. Only isDefault is mutable — gitName rename is rejected (FR13 — gitName is a stable, externally-typed identifier).'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Promotes a Branch to be the Project's default. Only isDefault is mutable — gitName rename is rejected (FR13 — gitName is a stable, externally-typed identifier).
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-compute-services-by-compute-service-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-compute-services-by-compute-service-id.mdx
deleted file mode 100644
index 4657c8882f..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-compute-services-by-compute-service-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Update compute service
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Updates the display name of a compute service.'
-full: true
-_openapi:
- method: PATCH
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Updates the display name of a compute service.
- path: '/v1/compute-services/{computeServiceId}'
-url: '/management-api/endpoints/[experimental]/patch-compute-services-by-compute-service-id'
-metaTitle: 'PATCH /v1/compute-services/{computeServiceId} | Update compute service'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Updates the display name of a compute service.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Updates the display name of a compute service.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-environment-variables-by-env-var-id.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-environment-variables-by-env-var-id.mdx
deleted file mode 100644
index d755b2a777..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/patch-environment-variables-by-env-var-id.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Update an environment variable's value
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Replaces the value of an existing environment variable. Only the value is mutable — the project, environment, key, and branch are fixed at create-time.'
-full: true
-_openapi:
- method: PATCH
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Replaces the value of an existing environment variable. Only the value is mutable — the project, environment, key, and branch are fixed at create-time.
- path: '/v1/environment-variables/{envVarId}'
-url: '/management-api/endpoints/[experimental]/patch-environment-variables-by-env-var-id'
-metaTitle: 'PATCH /v1/environment-variables/{envVarId} | Update an environment variable''s value'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Replaces the value of an existing environment variable. Only the value is mutable — the project, environment, key, and branch are fixed at create-time.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Replaces the value of an existing environment variable. Only the value is mutable — the project, environment, key, and branch are fixed at create-time.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-promote.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-promote.mdx
deleted file mode 100644
index 94f3adadd3..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-promote.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Promote compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Promotes a compute version to be the active version behind the service''s stable endpoint. The version must be running. Returns the service endpoint domain.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Promotes a compute version to be the active version behind the service's stable endpoint. The version must be running. Returns the service endpoint domain.
- path: '/v1/compute-services/{computeServiceId}/promote'
-url: '/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-promote'
-metaTitle: 'POST /v1/compute-services/{computeServiceId}/promote | Promote compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Promotes a compute version to be the active version behind the service''s stable endpoint. The version must be running. Returns the service endpoint domain.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Promotes a compute version to be the active version behind the service's stable endpoint. The version must be running. Returns the service endpoint domain.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-versions.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-versions.mdx
deleted file mode 100644
index f05936c1f9..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-versions.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Create compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute version under the specified compute service. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set (which forks the latest version''s artifact). Environment variables are merged with the previous version''s variables when one exists.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Creates a new compute version under the specified compute service. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set (which forks the latest version's artifact). Environment variables are merged with the previous version's variables when one exists.
- path: '/v1/compute-services/{computeServiceId}/versions'
-url: '/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-versions'
-metaTitle: 'POST /v1/compute-services/{computeServiceId}/versions | Create compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute version under the specified compute service. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set (which forks the latest version''s artifact). Environment variables are merged with the previous version''s variables when one exists.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Creates a new compute version under the specified compute service. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set (which forks the latest version's artifact). Environment variables are merged with the previous version's variables when one exists.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-start.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-start.mdx
deleted file mode 100644
index b35c2e3506..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-start.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Start compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.
- path: '/v1/compute-services/versions/{versionId}/start'
-url: '/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-start'
-metaTitle: 'POST /v1/compute-services/versions/{versionId}/start | Start compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-stop.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-stop.mdx
deleted file mode 100644
index b19549b5ff..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-stop.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Stop compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.
- path: '/v1/compute-services/versions/{versionId}/stop'
-url: '/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-stop'
-metaTitle: 'POST /v1/compute-services/versions/{versionId}/stop | Stop compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services.mdx
deleted file mode 100644
index 841863e3d6..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-compute-services.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Create compute service
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute service under the specified project. The `projectId` is required in the request body. The service is placed in the given region (or the default region if omitted).'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Creates a new compute service under the specified project. The `projectId` is required in the request body. The service is placed in the given region (or the default region if omitted).
- path: /v1/compute-services
-url: '/management-api/endpoints/[experimental]/post-compute-services'
-metaTitle: POST /v1/compute-services | Create compute service
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute service under the specified project. The `projectId` is required in the request body. The service is placed in the given region (or the default region if omitted).'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Creates a new compute service under the specified project. The `projectId` is required in the request body. The service is placed in the given region (or the default region if omitted).
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-environment-variables.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-environment-variables.mdx
deleted file mode 100644
index 932fc75ed5..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-environment-variables.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Create an environment variable
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new environment variable in a project''s `production` or `preview` environment. Returns 409 if a variable with the same key already exists in that environment — use PATCH to replace its value. Values are stored encrypted and are not returned by subsequent reads.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Creates a new environment variable in a project's `production` or `preview` environment. Returns 409 if a variable with the same key already exists in that environment — use PATCH to replace its value. Values are stored encrypted and are not returned by subsequent reads.
- path: /v1/environment-variables
-url: '/management-api/endpoints/[experimental]/post-environment-variables'
-metaTitle: POST /v1/environment-variables | Create an environment variable
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new environment variable in a project''s `production` or `preview` environment. Returns 409 if a variable with the same key already exists in that environment — use PATCH to replace its value. Values are stored encrypted and are not returned by subsequent reads.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Creates a new environment variable in a project's `production` or `preview` environment. Returns 409 if a variable with the same key already exists in that environment — use PATCH to replace its value. Values are stored encrypted and are not returned by subsequent reads.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-projects-by-project-id-branches.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-projects-by-project-id-branches.mdx
deleted file mode 100644
index c2a7098235..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-projects-by-project-id-branches.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Create a branch
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Creates a Branch under the specified Project. The first Branch in a Project is always created with isDefault=true regardless of the body value (FR4 first-Branch-is-default rule). Setting isDefault=true while another Branch already holds the default atomically swaps the flag.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Creates a Branch under the specified Project. The first Branch in a Project is always created with isDefault=true regardless of the body value (FR4 first-Branch-is-default rule). Setting isDefault=true while another Branch already holds the default atomically swaps the flag.
- path: '/v1/projects/{projectId}/branches'
-url: '/management-api/endpoints/[experimental]/post-projects-by-project-id-branches'
-metaTitle: 'POST /v1/projects/{projectId}/branches | Create a branch'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Creates a Branch under the specified Project. The first Branch in a Project is always created with isDefault=true regardless of the body value (FR4 first-Branch-is-default rule). Setting isDefault=true while another Branch already holds the default atomically swaps the flag.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Creates a Branch under the specified Project. The first Branch in a Project is always created with isDefault=true regardless of the body value (FR4 first-Branch-is-default rule). Setting isDefault=true while another Branch already holds the default atomically swaps the flag.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-projects-by-project-id-compute-services.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-projects-by-project-id-compute-services.mdx
deleted file mode 100644
index 117ec206f9..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-projects-by-project-id-compute-services.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Create compute service
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute service under the specified project. The service is placed in the given region (or the default region if omitted).'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Creates a new compute service under the specified project. The service is placed in the given region (or the default region if omitted).
- path: '/v1/projects/{projectId}/compute-services'
-url: '/management-api/endpoints/[experimental]/post-projects-by-project-id-compute-services'
-metaTitle: 'POST /v1/projects/{projectId}/compute-services | Create compute service'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute service under the specified project. The service is placed in the given region (or the default region if omitted).'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Creates a new compute service under the specified project. The service is placed in the given region (or the default region if omitted).
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions-by-version-id-start.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions-by-version-id-start.mdx
deleted file mode 100644
index 30504cd12a..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions-by-version-id-start.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Start compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.
- path: '/v1/versions/{versionId}/start'
-url: '/management-api/endpoints/[experimental]/post-versions-by-version-id-start'
-metaTitle: 'POST /v1/versions/{versionId}/start | Start compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions-by-version-id-stop.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions-by-version-id-stop.mdx
deleted file mode 100644
index 0691200326..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions-by-version-id-stop.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Stop compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.
- path: '/v1/versions/{versionId}/stop'
-url: '/management-api/endpoints/[experimental]/post-versions-by-version-id-stop'
-metaTitle: 'POST /v1/versions/{versionId}/stop | Stop compute version'
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions.mdx b/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions.mdx
deleted file mode 100644
index 58565e656d..0000000000
--- a/apps/docs/content/docs/management-api/endpoints/[experimental]/post-versions.mdx
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Create compute version
-description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute version under the specified compute service. The `computeServiceId` is required in the request body. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set. Environment variables are merged with the previous version''s variables when one exists.'
-full: true
-_openapi:
- method: POST
- toc: []
- structuredData:
- headings: []
- contents:
- - content: |-
- ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
- Creates a new compute version under the specified compute service. The `computeServiceId` is required in the request body. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set. Environment variables are merged with the previous version's variables when one exists.
- path: /v1/versions
-url: '/management-api/endpoints/[experimental]/post-versions'
-metaTitle: POST /v1/versions | Create compute version
-metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute version under the specified compute service. The `computeServiceId` is required in the request body. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set. Environment variables are merged with the previous version''s variables when one exists.'
----
-
-{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
-
-⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️
-
-Creates a new compute version under the specified compute service. The `computeServiceId` is required in the request body. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set. Environment variables are merged with the previous version's variables when one exists.
-
-
diff --git a/apps/docs/content/docs/management-api/endpoints/meta.json b/apps/docs/content/docs/management-api/endpoints/meta.json
index c68d6749de..ac98037d56 100644
--- a/apps/docs/content/docs/management-api/endpoints/meta.json
+++ b/apps/docs/content/docs/management-api/endpoints/meta.json
@@ -9,6 +9,8 @@
"integrations",
"projects",
"workspaces",
+ "connections",
+ "regions",
"misc"
]
}
diff --git a/apps/docs/package.json b/apps/docs/package.json
index 9d9b47bb12..096a3eb273 100644
--- a/apps/docs/package.json
+++ b/apps/docs/package.json
@@ -5,7 +5,8 @@
"type": "module",
"scripts": {
"fetch-openapi": "tsx ./scripts/fetch-openapi.ts",
- "generate:management-api-docs": "rimraf ./content/docs/management-api/endpoints/**/*.mdx && pnpm run fetch-openapi && tsx ./scripts/generate-docs.ts && fumadocs-mdx",
+ "generate:management-api-docs": "pnpm run fetch-openapi && tsx ./scripts/generate-docs.ts && pnpm run generate:postman-collection && fumadocs-mdx",
+ "generate:postman-collection": "tsx ./scripts/generate-postman-collection.ts",
"build": "pnpm run fetch-openapi && next build",
"start": "next start --port 3001",
"dev": "next dev --port 3001",
@@ -75,6 +76,7 @@
"tsx": "catalog:",
"tw-animate-css": "catalog:",
"typescript": "catalog:",
+ "openapi-to-postmanv2": "^6.0.1",
"unified": "^11.0.5"
}
}
diff --git a/apps/docs/public/prisma-management-api.postman_collection.json b/apps/docs/public/prisma-management-api.postman_collection.json
new file mode 100644
index 0000000000..e38208e339
--- /dev/null
+++ b/apps/docs/public/prisma-management-api.postman_collection.json
@@ -0,0 +1,7664 @@
+{
+ "item": [
+ {
+ "id": "d99f98c2-395c-4603-b96f-2b48cd82a51b",
+ "name": "Projects",
+ "description": {
+ "content": "",
+ "type": "text/plain"
+ },
+ "item": [
+ {
+ "id": "c5021631-7f9c-4bf7-83b3-dcf22b579bb8",
+ "name": "Get list of projects",
+ "request": {
+ "name": "Get list of projects",
+ "description": {
+ "content": "Returns the list of projects the token has access to.",
+ "type": "text/plain"
+ },
+ "url": {
+ "path": [
+ "v1",
+ "projects"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [
+ {
+ "disabled": true,
+ "key": "cursor",
+ "value": ""
+ },
+ {
+ "disabled": true,
+ "key": "limit",
+ "value": "100"
+ }
+ ],
+ "variable": []
+ },
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "auth": null
+ },
+ "response": [
+ {
+ "id": "17d603c1-1504-4a20-8d36-f1650ebc8dbb",
+ "name": "Returns the list of projects.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [
+ {
+ "key": "cursor",
+ "value": ""
+ },
+ {
+ "key": "limit",
+ "value": "100"
+ }
+ ],
+ "variable": []
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "body": {}
+ },
+ "status": "OK",
+ "code": 200,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"defaultRegion\": \"\",\n \"workspace\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"defaultRegion\": \"\",\n \"workspace\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "1f91ff93-6341-498f-a5d5-5b14134b4756",
+ "name": "Missing or invalid authorization token.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [
+ {
+ "key": "cursor",
+ "value": ""
+ },
+ {
+ "key": "limit",
+ "value": "100"
+ }
+ ],
+ "variable": []
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "body": {}
+ },
+ "status": "Unauthorized",
+ "code": 401,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ }
+ ],
+ "event": [],
+ "protocolProfileBehavior": {
+ "disableBodyPruning": true
+ }
+ },
+ {
+ "id": "4c33ae67-5b04-456f-8b26-e203c3d26737",
+ "name": "Create project with a postgres database",
+ "request": {
+ "name": "Create project with a postgres database",
+ "description": {
+ "content": "Creates a new project with a postgres database.",
+ "type": "text/plain"
+ },
+ "url": {
+ "path": [
+ "v1",
+ "projects"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": []
+ },
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "POST",
+ "auth": null,
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"createDatabase\": true,\n \"name\": \"\",\n \"region\": \"us-east-1\"\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "response": [
+ {
+ "id": "10aee70c-9932-46cc-865c-e163acc74fa0",
+ "name": "New project created.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": []
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "POST",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"createDatabase\": true,\n \"name\": \"\",\n \"region\": \"us-east-1\"\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Created",
+ "code": 201,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"defaultRegion\": \"\",\n \"workspace\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"database\": {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"isDefault\": \"\",\n \"defaultConnectionId\": \"\",\n \"connections\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"kind\": \"\",\n \"endpoints\": {\n \"direct\": {\n \"host\": \"\",\n \"port\": \"\",\n \"connectionString\": \"\"\n },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\",\n \"connectionString\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\",\n \"connectionString\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"kind\": \"\",\n \"endpoints\": {\n \"direct\": {\n \"host\": \"\",\n \"port\": \"\",\n \"connectionString\": \"\"\n },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\",\n \"connectionString\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\",\n \"connectionString\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"apiKeys\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"kind\": \"\",\n \"endpoints\": {\n \"direct\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"connectionString\": \"\",\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"kind\": \"\",\n \"endpoints\": {\n \"direct\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"connectionString\": \"\",\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"connectionString\": \"\",\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "d3b001c9-b48d-4d15-8d1a-8b30c69a08f8",
+ "name": "Missing or invalid authorization token.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": []
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "POST",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"createDatabase\": true,\n \"name\": \"\",\n \"region\": \"us-east-1\"\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Unauthorized",
+ "code": 401,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ }
+ ],
+ "event": [],
+ "protocolProfileBehavior": {
+ "disableBodyPruning": true
+ }
+ },
+ {
+ "id": "0be9e7e1-3823-46f4-a413-35ae33d7f4d0",
+ "name": "Delete project",
+ "request": {
+ "name": "Delete project",
+ "description": {
+ "content": "Deletes the project with the given ID.",
+ "type": "text/plain"
+ },
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "DELETE",
+ "auth": null
+ },
+ "response": [
+ {
+ "id": "4473f8e9-b47b-46d2-abf3-09ca70dbecc5",
+ "name": "Project deleted.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ }
+ ],
+ "method": "DELETE",
+ "body": {}
+ },
+ "status": "No Content",
+ "code": 204,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "text/plain"
+ }
+ ],
+ "body": "",
+ "cookie": [],
+ "_postman_previewlanguage": "text"
+ },
+ {
+ "id": "9a3a176a-12d0-496f-ac8e-fa820678807a",
+ "name": "Project cannot be deleted due to existing dependencies.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "DELETE",
+ "body": {}
+ },
+ "status": "Bad Request",
+ "code": 400,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "3e8b6fa6-8df8-42a5-beee-3aad5e553912",
+ "name": "Unauthorized",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "DELETE",
+ "body": {}
+ },
+ "status": "Unauthorized",
+ "code": 401,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "0274af51-439d-4800-acc9-19fc6457b9a1",
+ "name": "Project with the specified ID was not found",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "DELETE",
+ "body": {}
+ },
+ "status": "Not Found",
+ "code": 404,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ }
+ ],
+ "event": [],
+ "protocolProfileBehavior": {
+ "disableBodyPruning": true
+ }
+ },
+ {
+ "id": "40e801a6-c9b3-4158-9d6f-a61c315fdd00",
+ "name": "Get project",
+ "request": {
+ "name": "Get project",
+ "description": {
+ "content": "Returns the project with the given ID.",
+ "type": "text/plain"
+ },
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "auth": null
+ },
+ "response": [
+ {
+ "id": "ca056f02-3643-4ee1-89c6-b230a5e61b9c",
+ "name": "Project retrieved.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "body": {}
+ },
+ "status": "OK",
+ "code": 200,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"defaultRegion\": \"\",\n \"workspace\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "07ae7ba9-d8d1-46d6-9f0d-0e8c83bece46",
+ "name": "Missing or invalid authorization token.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "body": {}
+ },
+ "status": "Unauthorized",
+ "code": 401,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "43d0a9bc-27fc-45bb-8303-095e634d2d2e",
+ "name": "Project with the specified ID was not found.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "body": {}
+ },
+ "status": "Not Found",
+ "code": 404,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ }
+ ],
+ "event": [],
+ "protocolProfileBehavior": {
+ "disableBodyPruning": true
+ }
+ },
+ {
+ "id": "d6f7115d-d839-4658-9c3d-7d7502d55a31",
+ "name": "Update project",
+ "request": {
+ "name": "Update project",
+ "description": {
+ "content": "Updates the project with the given ID.",
+ "type": "text/plain"
+ },
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "PATCH",
+ "auth": null,
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "response": [
+ {
+ "id": "458155dc-878b-434a-b22d-d99f78949264",
+ "name": "Project updated.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "PATCH",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"defaultRegion\": \"\",\n \"workspace\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n }\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "3fce3c31-9058-4df3-980d-232e992a9982",
+ "name": "Missing or invalid authorization token.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "PATCH",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Unauthorized",
+ "code": 401,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "da73f48f-ebed-424e-94d0-0e28d460a631",
+ "name": "Actor does not have access to the project.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "PATCH",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Forbidden",
+ "code": 403,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "18b154d3-e790-4cfd-a67c-b1fa62efc2ab",
+ "name": "Project with the specified ID was not found.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "PATCH",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Not Found",
+ "code": 404,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "2b231028-a006-4d1e-9ab0-bbc250b086e6",
+ "name": "Validation failed.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "PATCH",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
+ "code": 422,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ }
+ ],
+ "event": [],
+ "protocolProfileBehavior": {
+ "disableBodyPruning": true
+ }
+ },
+ {
+ "id": "f208130e-9a00-48f0-bbea-dbc72227dbf7",
+ "name": "Transfer project",
+ "request": {
+ "name": "Transfer project",
+ "description": {
+ "content": "Transfer the project with the given ID to the new owner's workspace",
+ "type": "text/plain"
+ },
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id",
+ "transfer"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "POST",
+ "auth": null,
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"recipientAccessToken\": \"\"\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "response": [
+ {
+ "id": "177fcef7-3d9f-49d8-bd50-d1c15567f294",
+ "name": "Project transferred",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id",
+ "transfer"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ }
+ ],
+ "method": "POST",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"recipientAccessToken\": \"\"\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "No Content",
+ "code": 204,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "text/plain"
+ }
+ ],
+ "body": "",
+ "cookie": [],
+ "_postman_previewlanguage": "text"
+ },
+ {
+ "id": "482a5671-eadd-4f03-b0a7-b7e264962df1",
+ "name": "Missing or invalid authorization token.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id",
+ "transfer"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "POST",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"recipientAccessToken\": \"\"\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Unauthorized",
+ "code": 401,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ },
+ {
+ "id": "f0c9f0ab-33b4-4d8a-9f97-d105ac6344f6",
+ "name": "Project with the given ID was not found.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "projects",
+ ":id",
+ "transfer"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [],
+ "variable": [
+ {
+ "disabled": false,
+ "type": "any",
+ "value": "",
+ "key": "id",
+ "description": "(Required) "
+ }
+ ]
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "POST",
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"recipientAccessToken\": \"\"\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ }
+ },
+ "status": "Not Found",
+ "code": 404,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}",
+ "cookie": [],
+ "_postman_previewlanguage": "json"
+ }
+ ],
+ "event": [],
+ "protocolProfileBehavior": {
+ "disableBodyPruning": true
+ }
+ }
+ ],
+ "event": []
+ },
+ {
+ "id": "49bd2807-7d4e-4a77-b87f-26b1a8433f59",
+ "name": "Databases",
+ "description": {
+ "content": "",
+ "type": "text/plain"
+ },
+ "item": [
+ {
+ "id": "e5757eae-5f6b-4f12-84d9-9880d6226945",
+ "name": "List databases",
+ "request": {
+ "name": "List databases",
+ "description": {
+ "content": "Returns all databases the token has access to. Optionally filter by project ID.",
+ "type": "text/plain"
+ },
+ "url": {
+ "path": [
+ "v1",
+ "databases"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [
+ {
+ "disabled": true,
+ "key": "cursor",
+ "value": ""
+ },
+ {
+ "disabled": true,
+ "key": "limit",
+ "value": "100"
+ },
+ {
+ "disabled": true,
+ "key": "projectId",
+ "value": ""
+ }
+ ],
+ "variable": []
+ },
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "auth": null
+ },
+ "response": [
+ {
+ "id": "7149fcef-e7ec-404b-81fe-90ebccb8cfb6",
+ "name": "Returns the list of databases.",
+ "originalRequest": {
+ "url": {
+ "path": [
+ "v1",
+ "databases"
+ ],
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "query": [
+ {
+ "key": "cursor",
+ "value": ""
+ },
+ {
+ "key": "limit",
+ "value": "100"
+ },
+ {
+ "key": "projectId",
+ "value": ""
+ }
+ ],
+ "variable": []
+ },
+ "header": [
+ {
+ "description": {
+ "content": "Added as a part of security scheme: oauth2",
+ "type": "text/plain"
+ },
+ "key": "Authorization",
+ "value": ""
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "method": "GET",
+ "body": {}
+ },
+ "status": "OK",
+ "code": 200,
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"createdAt\": \"\",\n \"isDefault\": \"\",\n \"defaultConnectionId\": \"\",\n \"connections\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\",\n \"kind\": \"\",\n \"endpoints\": {\n \"direct\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"