{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/your-vito-url" } ], "info": { "name": "API Documentation", "_postman_id": "bda1e04e-cc4f-4eae-9beb-dba7c9287038", "description": "VitoDeploy's API documentation.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "cron-jobs", "description": "", "item": [ { "name": "list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/cron-jobs", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/cron-jobs", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all cron jobs." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"server_id\":null,\"command\":\"ls -la\",\"user\":\"root\",\"frequency\":\"* * * * *\",\"status\":\"ready\",\"created_at\":null,\"updated_at\":null},{\"id\":null,\"server_id\":null,\"command\":\"ls -la\",\"user\":\"root\",\"frequency\":\"* * * * *\",\"status\":\"ready\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next »\",\"active\":false}],\"path\":\"\\\/\",\"per_page\":25,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/cron-jobs", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/cron-jobs", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"command\":\"quia\",\"user\":\"root\",\"frequency\":\"* * * * *\"}" }, "description": "Create a new cron job." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"server_id\":null,\"command\":\"ls -la\",\"user\":\"root\",\"frequency\":\"* * * * *\",\"status\":\"ready\",\"created_at\":null,\"updated_at\":null}", "name": "" } ] }, { "name": "show", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/cron-jobs\/:cronJob_id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/cron-jobs\/:cronJob_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." }, { "id": "cronJob_id", "key": "cronJob_id", "value": "6", "description": "The ID of the cronJob." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a cron job by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"server_id\":null,\"command\":\"ls -la\",\"user\":\"root\",\"frequency\":\"* * * * *\",\"status\":\"ready\",\"created_at\":null,\"updated_at\":null}", "name": "" } ] }, { "name": "delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/cron-jobs\/:cronJob_id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/cron-jobs\/:cronJob_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." }, { "id": "cronJob_id", "key": "cronJob_id", "value": "13", "description": "The ID of the cronJob." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete cron job." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "database-users", "description": "", "item": [ { "name": "list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/database-users", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/database-users", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all database users." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"server_id\":null,\"username\":\"letha64\",\"databases\":[],\"host\":\"%\",\"status\":null,\"created_at\":null,\"updated_at\":null},{\"id\":null,\"server_id\":null,\"username\":\"hagenes.lurline\",\"databases\":[],\"host\":\"%\",\"status\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next »\",\"active\":false}],\"path\":\"\\\/\",\"per_page\":25,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/database-users", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/database-users", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"qui\",\"password\":\"xYv*3,#HQ=5*m{p]DI\",\"global\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":5,\"project_id\":null,\"global\":true,\"name\":\"Neha Little\",\"provider\":\"github\",\"created_at\":\"2025-04-05T17:48:03.000000Z\",\"updated_at\":\"2025-04-05T17:48:03.000000Z\"}", "name": "" } ] }, { "name": "delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/source-controls\/:sourceControl_id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/source-controls\/:sourceControl_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "sourceControl_id", "key": "sourceControl_id", "value": "1", "description": "The ID of the sourceControl." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "ssh-keys", "description": "", "item": [ { "name": "list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/ssh-keys", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/ssh-keys", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all ssh keys." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"user\":null,\"name\":\"Santa Goyette\",\"created_at\":null,\"updated_at\":null},{\"id\":null,\"user\":null,\"name\":\"Cecil Cummings\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next »\",\"active\":false}],\"path\":\"\\\/\",\"per_page\":25,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/ssh-keys", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/ssh-keys", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key_id\":\"explicabo\",\"name\":\"deleniti\",\"public_key\":\"sapiente\"}" }, "description": "Deploy ssh key to server." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"user\":null,\"name\":\"Mr. Reagan Jacobson V\",\"created_at\":null,\"updated_at\":null}", "name": "" } ] }, { "name": "delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/servers\/:server_id\/ssh-keys\/:sshKey_id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/servers\/:server_id\/ssh-keys\/:sshKey_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "server_id", "key": "server_id", "value": "29", "description": "The ID of the server." }, { "id": "sshKey_id", "key": "sshKey_id", "value": "1", "description": "The ID of the sshKey." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete ssh key from server." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "storage-providers", "description": "", "item": [ { "name": "list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/storage-providers", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/storage-providers", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":5,\"project_id\":null,\"global\":true,\"name\":\"veritatis\",\"provider\":\"ftp\",\"created_at\":\"2025-04-05T17:48:03.000000Z\",\"updated_at\":\"2025-04-05T17:48:03.000000Z\"},{\"id\":6,\"project_id\":null,\"global\":true,\"name\":\"voluptas\",\"provider\":\"dropbox\",\"created_at\":\"2025-04-05T17:48:03.000000Z\",\"updated_at\":\"2025-04-05T17:48:03.000000Z\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next »\",\"active\":false}],\"path\":\"\\\/\",\"per_page\":25,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/storage-providers", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/storage-providers", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"ab\",\"name\":\"quo\",\"token\":\"in\",\"key\":\"sunt\",\"secret\":\"molestias\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":5,\"project_id\":null,\"global\":true,\"name\":\"asperiores\",\"provider\":\"dropbox\",\"created_at\":\"2025-04-05T17:48:03.000000Z\",\"updated_at\":\"2025-04-05T17:48:03.000000Z\"}", "name": "" } ] }, { "name": "show", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/storage-providers\/:storageProvider_id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/storage-providers\/:storageProvider_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "storageProvider_id", "key": "storageProvider_id", "value": "3", "description": "The ID of the storageProvider." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":5,\"project_id\":null,\"global\":true,\"name\":\"ipsum\",\"provider\":\"local\",\"created_at\":\"2025-04-05T17:48:03.000000Z\",\"updated_at\":\"2025-04-05T17:48:03.000000Z\"}", "name": "" } ] }, { "name": "update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/storage-providers\/:storageProvider_id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/storage-providers\/:storageProvider_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "storageProvider_id", "key": "storageProvider_id", "value": "3", "description": "The ID of the storageProvider." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"voluptas\",\"global\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":5,\"project_id\":null,\"global\":true,\"name\":\"minima\",\"provider\":\"ftp\",\"created_at\":\"2025-04-05T17:48:03.000000Z\",\"updated_at\":\"2025-04-05T17:48:03.000000Z\"}", "name": "" } ] }, { "name": "delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project_id\/storage-providers\/:storageProvider_id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project_id\/storage-providers\/:storageProvider_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "storageProvider_id", "key": "storageProvider_id", "value": "3", "description": "The ID of the storageProvider." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }