{ "info": { "_postman_id": "b8e2c0a1-3d4f-4a2b-9c5e-7f1a2b3c4d5e", "name": "Depot API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "HTTP/JSON view of the Depot API (Connect/gRPC). Each request is an HTTP POST to /{package}.{Service}/{Method} with a JSON body, authenticated with Authorization: Bearer {{bearerToken}}.\n\nContact Support:\n Name: Depot Support\n Email: help@depot.dev", "type": "text/plain" } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "variable": [ { "type": "string", "value": "https://api.depot.dev", "key": "baseUrl" } ], "event": [], "item": [ { "name": "ProjectService", "description": "depot.core.v1.ProjectService - manage projects and project tokens.", "item": [ { "name": "List projects in the organization.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/ListProjects", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "ListProjects"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pageSize\": 50\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a new project.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/CreateProject", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "CreateProject"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"my-app\",\n \"regionId\": \"us-east-1\",\n \"cachePolicy\": {\n \"keepBytes\": \"53687091200\",\n \"keepDays\": 14\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single project by ID.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/GetProject", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "GetProject"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update an existing project.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/UpdateProject", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "UpdateProject"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\",\n \"name\": \"my-app-renamed\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a project.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/DeleteProject", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "DeleteProject"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset (clear) the build cache for a project.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/ResetProjectCache", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "ResetProjectCache"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List project-scoped tokens.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/ListProjectTokens", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "ListProjectTokens"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a project-scoped token.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/CreateProjectToken", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "CreateProjectToken"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\",\n \"description\": \"CI token\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a project-scoped token.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.core.v1.ProjectService/DeleteProjectToken", "host": ["{{baseUrl}}"], "path": ["depot.core.v1.ProjectService", "DeleteProjectToken"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\",\n \"tokenId\": \"tok_abc123\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "BuildService", "description": "depot.build.v1.BuildService - register, finish, get, and list builds.", "item": [ { "name": "Register a new build within a project.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.build.v1.BuildService/CreateBuild", "host": ["{{baseUrl}}"], "path": ["depot.build.v1.BuildService", "CreateBuild"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark a build as finished.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.build.v1.BuildService/FinishBuild", "host": ["{{baseUrl}}"], "path": ["depot.build.v1.BuildService", "FinishBuild"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"buildId\": \"build_abc123\",\n \"result\": {\n \"success\": {}\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single build by ID.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.build.v1.BuildService/GetBuild", "host": ["{{baseUrl}}"], "path": ["depot.build.v1.BuildService", "GetBuild"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"buildId\": \"build_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List builds for a project.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.build.v1.BuildService/ListBuilds", "host": ["{{baseUrl}}"], "path": ["depot.build.v1.BuildService", "ListBuilds"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "BuildKitService", "description": "depot.buildkit.v1.BuildKitService - acquire a low-level BuildKit machine connection.", "item": [ { "name": "Acquire a BuildKit machine endpoint for a build.", "request": { "method": "POST", "url": { "raw": "{{baseUrl}}/depot.buildkit.v1.BuildKitService/GetEndpoint", "host": ["{{baseUrl}}"], "path": ["depot.buildkit.v1.BuildKitService", "GetEndpoint"] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"buildId\": \"build_abc123\",\n \"platform\": \"PLATFORM_AMD64\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }