{ "item": [ { "name": "Projects", "description": { "content": "", "type": "text/plain" }, "item": [ { "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": [ { "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" }, { "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 } }, { "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": [ { "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 \"branchId\": \"\",\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" }, { "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 } }, { "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": [ { "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" }, { "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" }, { "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" }, { "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 } }, { "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": [ { "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" }, { "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" }, { "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 } }, { "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 }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "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 }\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" }, { "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 }\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" }, { "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 }\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" }, { "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 }\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" }, { "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 }\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 } }, { "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": [ { "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" }, { "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" }, { "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": [] }, { "name": "Databases", "description": { "content": "", "type": "text/plain" }, "item": [ { "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": "" }, { "disabled": true, "key": "branchId", "value": "" }, { "disabled": true, "key": "branchGitName", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returns the list of databases.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" }, { "key": "projectId", "value": "" }, { "key": "branchId", "value": "" }, { "key": "branchGitName", "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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\"\n },\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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\"\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" }, { "key": "projectId", "value": "" }, { "key": "branchId", "value": "" }, { "key": "branchGitName", "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": "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" }, { "name": "Actor does not have access to the requested databases.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" }, { "key": "projectId", "value": "" }, { "key": "branchId", "value": "" }, { "key": "branchGitName", "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": "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create database /v1/databases", "request": { "name": "Create database", "description": { "content": "Creates a new database in the specified project.", "type": "text/plain" }, "url": { "path": [ "v1", "databases" ], "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 \"projectId\": \"\",\n \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\",\n \"branchGitName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created a new database.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "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 \"projectId\": \"\",\n \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\",\n \"branchGitName\": \"\"\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 \"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 \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid request parameters.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "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 \"projectId\": \"\",\n \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\",\n \"branchGitName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "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" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "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 \"projectId\": \"\",\n \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\",\n \"branchGitName\": \"\"\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" }, { "name": "Actor does not have access to the specified project.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "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 \"projectId\": \"\",\n \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\",\n \"branchGitName\": \"\"\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" }, { "name": "Project not found.", "originalRequest": { "url": { "path": [ "v1", "databases" ], "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 \"projectId\": \"\",\n \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\",\n \"branchGitName\": \"\"\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 } }, { "name": "Get database", "request": { "name": "Get database", "description": { "content": "Returns the database with the given ID.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned the database with the given ID.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" }, { "name": "Actor does not have access to the database.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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": "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" }, { "name": "Database with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 } }, { "name": "Update database", "request": { "name": "Update database", "description": { "content": "Updates the database with the given ID.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"branchId\": \"\",\n \"branchGitName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Updated the database.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"branchId\": \"\",\n \"branchGitName\": \"\"\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 \"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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"branchId\": \"\",\n \"branchGitName\": \"\"\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" }, { "name": "Actor does not have access to the database.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"branchId\": \"\",\n \"branchGitName\": \"\"\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" }, { "name": "Database with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"branchId\": \"\",\n \"branchGitName\": \"\"\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 } }, { "name": "Delete database", "request": { "name": "Delete database", "description": { "content": "Deletes the database with the given ID.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "name": "Deleted the database successfully.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" }, { "name": "Cannot delete the default environment.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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": "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" }, { "name": "Database with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 } }, { "name": "Restore database (destructive)", "request": { "name": "Restore database (destructive)", "description": { "content": "⚠️ **Destructive operation** — this immediately and irreversibly overwrites all data in the target database with the contents of the specified backup. Any data written since the backup was taken will be lost. Ensure you have a recent backup of the target database before proceeding.\n\nReplaces the data in an existing database from a backup. Connections and credentials are preserved — only the data layer is replaced.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":targetDatabaseId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "targetDatabaseId", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"source\": {\n \"type\": \"\",\n \"databaseId\": \"\",\n \"backupId\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Database restore initiated. The database status will be \"recovering\" until the restore completes.", "originalRequest": { "url": { "path": [ "v1", "databases", ":targetDatabaseId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "targetDatabaseId", "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 \"source\": {\n \"type\": \"\",\n \"databaseId\": \"\",\n \"backupId\": \"\"\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 \"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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\",\n \"databaseId\": \"\",\n \"backupId\": \"\"\n },\n \"branchId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":targetDatabaseId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "targetDatabaseId", "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 \"source\": {\n \"type\": \"\",\n \"databaseId\": \"\",\n \"backupId\": \"\"\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" }, { "name": "Target database, source database, or backup not found.", "originalRequest": { "url": { "path": [ "v1", "databases", ":targetDatabaseId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "targetDatabaseId", "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 \"source\": {\n \"type\": \"\",\n \"databaseId\": \"\",\n \"backupId\": \"\"\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" }, { "name": "Target database is currently provisioning or recovering and cannot be restored.", "originalRequest": { "url": { "path": [ "v1", "databases", ":targetDatabaseId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "targetDatabaseId", "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 \"source\": {\n \"type\": \"\",\n \"databaseId\": \"\",\n \"backupId\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"hint\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid source type or backup not usable.", "originalRequest": { "url": { "path": [ "v1", "databases", ":targetDatabaseId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "targetDatabaseId", "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 \"source\": {\n \"type\": \"\",\n \"databaseId\": \"\",\n \"backupId\": \"\"\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 } }, { "name": "Get list of databases", "request": { "name": "Get list of databases", "description": { "content": "Returns databases for the given project.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned the databases for the given project ID.", "originalRequest": { "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "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 {\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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\"\n },\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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\"\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "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" }, { "name": "Project with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "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 } }, { "name": "Create database /v1/projects/{projectId}/databases", "request": { "name": "Create database", "description": { "content": "Creates a new database for the given project.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"fromDatabase\": {\n \"id\": \"\",\n \"backupId\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created a new database for the project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "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 \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"fromDatabase\": {\n \"id\": \"\",\n \"backupId\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n }\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 \"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 \"project\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n },\n \"branchId\": \"\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is invalid due to missing or invalid parameters.", "originalRequest": { "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "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 \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"fromDatabase\": {\n \"id\": \"\",\n \"backupId\": \"\"\n },\n \"source\": {\n \"type\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "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" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "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 \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"fromDatabase\": {\n \"id\": \"\",\n \"backupId\": \"\"\n },\n \"source\": {\n \"type\": \"\"\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" }, { "name": "Project does not belong to the service token’s workspace.", "originalRequest": { "url": { "path": [ "v1", "projects", ":projectId", "databases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "projectId", "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 \"region\": \"us-east-1\",\n \"name\": \"\",\n \"isDefault\": false,\n \"fromDatabase\": {\n \"id\": \"\",\n \"backupId\": \"\"\n },\n \"source\": {\n \"type\": \"\"\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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Databases Connections", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Get list of database connections", "request": { "name": "Get list of database connections", "description": { "content": "Returns all connections for the given database.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":databaseId", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned all connections for the given database.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 {\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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create database connection string", "request": { "name": "Create database connection string", "description": { "content": "Creates a new connection string for the given database.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":databaseId", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created a new connection string for the database.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"name\": \"\"\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 \"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 \"connectionString\": \"\",\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\",\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"name\": \"\"\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" }, { "name": "Database with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"name\": \"\"\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": [] }, { "name": "Database Backups", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Get list of backups", "request": { "name": "Get list of backups", "description": { "content": "Returns backups for the specified database.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":databaseId", "backups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned backups for the given database.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "backups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 {\n \"id\": \"\",\n \"backupType\": \"\",\n \"createdAt\": \"\",\n \"status\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"backupType\": \"\",\n \"createdAt\": \"\",\n \"status\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n }\n ],\n \"meta\": {\n \"backupRetentionDays\": \"\"\n },\n \"pagination\": {\n \"hasMore\": \"\",\n \"limit\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "backups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" }, { "name": "Database with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "backups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" }, { "name": "Remote database backups are not supported", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "backups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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": "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 } } ], "event": [] }, { "name": "Database Usage", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Get database usage metrics", "request": { "name": "Get database usage metrics", "description": { "content": "Returns usage metrics for the specified database.", "type": "text/plain" }, "url": { "path": [ "v1", "databases", ":databaseId", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "startDate", "value": "" }, { "disabled": true, "key": "endDate", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned usage metrics for the given database.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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 \"period\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"metrics\": {\n \"operations\": {\n \"used\": \"\",\n \"unit\": \"\"\n },\n \"storage\": {\n \"used\": \"\",\n \"unit\": \"\"\n }\n },\n \"generatedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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": "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" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" }, { "name": "Database with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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" }, { "name": "Error occurred while fetching metrics", "originalRequest": { "url": { "path": [ "v1", "databases", ":databaseId", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "databaseId", "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": "Internal Server Error", "code": 500, "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": [] }, { "name": "Connections", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "List connections", "request": { "name": "List connections", "description": { "content": "Returns all connections the actor has access to, with optional database filter.", "type": "text/plain" }, "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "100" }, { "disabled": true, "key": "databaseId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned list of connections.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" }, { "key": "databaseId", "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 \"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\": \"\",\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 },\n \"pooled\": {\n \"host\": \"\",\n \"port\": \"\"\n },\n \"accelerate\": {\n \"host\": \"\",\n \"port\": \"\"\n }\n },\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" }, { "key": "databaseId", "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": "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 } }, { "name": "Create connection", "request": { "name": "Create connection", "description": { "content": "Creates a new connection for the specified database.", "type": "text/plain" }, "url": { "path": [ "v1", "connections" ], "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 \"databaseId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Created a new connection.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "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 \"databaseId\": \"\",\n \"name\": \"\"\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 \"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 \"connectionString\": \"\",\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\",\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "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 \"databaseId\": \"\",\n \"name\": \"\"\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" }, { "name": "Database with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "connections" ], "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 \"databaseId\": \"\",\n \"name\": \"\"\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 } }, { "name": "Get connection", "request": { "name": "Get connection", "description": { "content": "Returns the connection with the given ID.", "type": "text/plain" }, "url": { "path": [ "v1", "connections", ":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": [ { "name": "Returned the connection.", "originalRequest": { "url": { "path": [ "v1", "connections", ":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 \"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\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "connections", ":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" }, { "name": "Connection with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "connections", ":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 } }, { "name": "Delete connection", "request": { "name": "Delete connection", "description": { "content": "Deletes the connection with the given ID.", "type": "text/plain" }, "url": { "path": [ "v1", "connections", ":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": [ { "name": "Deleted the connection.", "originalRequest": { "url": { "path": [ "v1", "connections", ":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" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "connections", ":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" }, { "name": "Connection with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "connections", ":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 } }, { "name": "Rotate connection credentials", "request": { "name": "Rotate connection credentials", "description": { "content": "Generates new credentials for the connection with the given ID. Revocation of the previous credentials is best-effort.", "type": "text/plain" }, "url": { "path": [ "v1", "connections", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Rotated connection credentials.", "originalRequest": { "url": { "path": [ "v1", "connections", ":id", "rotate" ], "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": {} }, "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 \"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 \"connectionString\": \"\",\n \"database\": {\n \"id\": \"\",\n \"url\": \"\",\n \"name\": \"\"\n },\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\",\n \"directConnection\": {\n \"host\": \"\",\n \"pass\": \"\",\n \"user\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "connections", ":id", "rotate" ], "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": {} }, "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" }, { "name": "Connection with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "connections", ":id", "rotate" ], "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": {} }, "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": [] }, { "name": "Integrations", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Get list of integrations /v1/integrations", "request": { "name": "Get list of integrations", "description": { "content": "Returns integrations filtered by workspace ID.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "100" }, { "disabled": true, "key": "workspaceId", "value": "", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned the integrations for the given workspace.", "originalRequest": { "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" }, { "key": "workspaceId", "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 \"url\": \"\",\n \"createdAt\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"client\": {\n \"id\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\"\n },\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"createdAt\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"client\": {\n \"id\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\"\n },\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" }, { "key": "workspaceId", "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": "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 } }, { "name": "Get integration by ID", "request": { "name": "Get integration by ID", "description": { "content": "Returns a single integration by its ID.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", ":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": [ { "name": "Returned the integration.", "originalRequest": { "url": { "path": [ "v1", "integrations", ":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 \"url\": \"\",\n \"createdAt\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"client\": {\n \"id\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\"\n },\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "integrations", ":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" }, { "name": "Integration with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "integrations", ":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 } }, { "name": "Delete integration", "request": { "name": "Delete integration", "description": { "content": "Revokes the integration tokens by integration ID.", "type": "text/plain" }, "url": { "path": [ "v1", "integrations", ":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": [ { "name": "Revoked the integration tokens.", "originalRequest": { "url": { "path": [ "v1", "integrations", ":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" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "integrations", ":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" }, { "name": "Integration with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "integrations", ":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 } }, { "name": "Get list of integrations /v1/workspaces/{workspaceId}/integrations", "request": { "name": "Get list of integrations", "description": { "content": "Returns integrations for the given workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "cursor", "value": "" }, { "disabled": true, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returned the integrations for the given workspace ID.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "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 {\n \"id\": \"\",\n \"url\": \"\",\n \"createdAt\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"client\": {\n \"id\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\"\n },\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"createdAt\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"client\": {\n \"id\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\"\n },\n \"createdByUser\": {\n \"id\": \"\",\n \"email\": \"\",\n \"displayName\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "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" }, { "name": "Workspace with the given ID was not found.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "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 } }, { "name": "Revoke integration tokens", "request": { "name": "Revoke integration tokens", "description": { "content": "Revokes the integration tokens with the given client ID.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "clientId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "name": "Revoked the integration tokens.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "clientId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "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" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "clientId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "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" }, { "name": "Integration with the given client ID was not found.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":workspaceId", "integrations", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "clientId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "workspaceId", "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 } } ], "event": [] }, { "name": "Workspaces", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Get list of workspaces", "request": { "name": "Get list of workspaces", "description": { "content": "Returns the list of workspaces the current token can access.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces" ], "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": [ { "name": "Returns the list of workspaces the current token can access.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "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 },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\",\n \"name\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"pagination\": {\n \"nextCursor\": \"\",\n \"hasMore\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "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 } }, { "name": "Get workspace", "request": { "name": "Get workspace", "description": { "content": "Returns the workspace with the given ID.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces", ":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": [ { "name": "Workspace retrieved.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":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 }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":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" }, { "name": "Workspace with the specified ID was not found.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":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 } } ], "event": [] }, { "name": "Regions", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Get all regions", "request": { "name": "Get all regions", "description": { "content": "Returns all available regions across products. Optionally filter by product.", "type": "text/plain" }, "url": { "path": [ "v1", "regions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "product", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returns all available regions.", "originalRequest": { "url": { "path": [ "v1", "regions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "product", "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 \"name\": \"\",\n \"product\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"product\": \"\",\n \"status\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "regions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "product", "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": "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 } } ], "event": [] }, { "name": "Misc", "description": { "content": "", "type": "text/plain" }, "item": [ { "name": "Get Prisma Postgres regions", "request": { "name": "Get Prisma Postgres regions", "description": { "content": "Returns all available regions for Prisma Postgres.", "type": "text/plain" }, "url": { "path": [ "v1", "regions", "postgres" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returns all available regions for Prisma Postgres.", "originalRequest": { "url": { "path": [ "v1", "regions", "postgres" ], "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": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "regions", "postgres" ], "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": "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 } }, { "name": "Get Prisma Accelerate regions", "request": { "name": "Get Prisma Accelerate regions", "description": { "content": "Returns all available regions for Prisma Accelerate.", "type": "text/plain" }, "url": { "path": [ "v1", "regions", "accelerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Returns all available regions for Prisma Accelerate.", "originalRequest": { "url": { "path": [ "v1", "regions", "accelerate" ], "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": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing or invalid authorization token.", "originalRequest": { "url": { "path": [ "v1", "regions", "accelerate" ], "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": "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 } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.prisma.io", "key": "baseUrl" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "authUrl", "value": "https://auth.prisma.io/authorize", "type": "string" }, { "key": "accessTokenUrl", "value": "https://auth.prisma.io/token", "type": "string" }, { "key": "scope", "value": "workspace:admin", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "info": { "name": "Prisma Postgres Management API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "REST API for managing Prisma Postgres projects, databases, backups, and workspaces.", "type": "text/plain" } } }