Compare commits

...

23 Commits
cli ... 2.5.0

Author SHA1 Message Date
76059aff3c Update app.php 2025-04-12 21:15:58 +02:00
ff4d560e44 Fix aws connect bug (#577) 2025-04-05 23:50:12 +02:00
dda345f565 Bump vite from 6.2.3 to 6.2.5 (#576)
Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 6.2.3 to 6.2.5.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v6.2.5/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v6.2.5/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-version: 6.2.5
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-04-05 23:38:30 +02:00
564b97e2aa fix: add missing backticks in Blade for MySQL/MariaDB database names with hyphens (#523)
* fix: add missing backticks in Blade for MySQL/MariaDB database names with hyphens

Before:
The CREATE DATABASE command failed for database names containing hyphens (-) because MySQL/MariaDB requires backticks around such names, but they were missing in the Blade template.

After:
Backticks (```) are now correctly added in the Blade template, ensuring MySQL properly interprets database names with hyphens.

Why:
MySQL/MariaDB does not allow hyphens in database names unless they are enclosed in backticks. The Blade template was missing these backticks, causing syntax errors. Adding them ensures the command executes successfully. 🚀

* fix: added hyphens to other places as well

---------

Co-authored-by: Saeed Vaziry <61919774+saeedvaziry@users.noreply.github.com>
2025-04-05 21:58:25 +02:00
4e5f975917 fix: allow reuse of a database name (#571)
* fix: allow reuse of a database name

* style

---------

Co-authored-by: Saeed Vaziry <61919774+saeedvaziry@users.noreply.github.com>
Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
2025-04-05 21:50:14 +02:00
f3500497d0 fix(site/workers): add-all-ssh-users-to-worker-edit (#567)
* fix(site/workers): add-all-ssh-users-to-worker-edit

* adjust site users and server users for workers

---------

Co-authored-by: Saeed Vaziry <61919774+saeedvaziry@users.noreply.github.com>
Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
2025-04-05 20:57:29 +02:00
996df64386 Bump vite from 6.2.0 to 6.2.3 (#574)
Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 6.2.0 to 6.2.3.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v6.2.3/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v6.2.3/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Saeed Vaziry <61919774+saeedvaziry@users.noreply.github.com>
2025-04-05 20:00:16 +02:00
e98e974e20 Add endpoint for reading and updating site .env file (#564)
* feat(api): Add endpoint for reading site .env file

- Add GET /api/projects/{project}/servers/{server}/sites/{site}/env endpoint
- Add feature tests with SSH mocking

* added updating env

* fix coding style

* generate docs

---------

Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
2025-04-05 19:59:57 +02:00
2a670146d8 Add endpoint for triggering site deployment (#563)
* feat(api): Add endpoint for triggering site deployment

- Add POST /api/projects/{project}/servers/{server}/sites/{site}/deploy endpoint
- Add feature tests

* fix merge issue and generate api docs

* fix merge

---------

Co-authored-by: Saeed Vaziry <61919774+saeedvaziry@users.noreply.github.com>
Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
2025-04-05 19:41:52 +02:00
f483f7fdca Add site redirects (#552)
* feat(redirects): add redirects to sites

* chore(style): fixed coding style issues

* style: fix php-stan docblocks

* style: pint cleanup

* tests: fixed redirect test suite

* feat: vhosts include additional configs

* fix: use exact location matching

* - add enums
- use queues
- use vhost rather than separate conf files
- vhost formatter
- cleanup

* generate docs

---------

Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
2025-03-31 17:30:57 +02:00
7882d2022c Add endpoint for reading & updating site deployment script (#562)
* feat(api): Add endpoint for updating site deployment script

- Add PUT /api/projects/{project}/servers/{server}/sites/{site}/deployment-script endpoint
- Add feature tests for successful and failed updates

* added reading deployment script as well

* generate docs

---------

Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
2025-03-29 21:49:28 +01:00
03be2d3ee2 Add API endpoint to update site aliases (#551) 2025-03-21 10:26:51 +01:00
f89e7af34e fix server workers 500 error 2025-03-16 14:38:10 +01:00
7886e2a113 Bump version 2.4.0 (#548) 2025-03-16 14:10:55 +01:00
72352aad8d Add workers to servers (#547) 2025-03-16 14:09:15 +01:00
48ae561ea4 code-style 2025-03-13 20:53:14 +01:00
0f06d81aac Add database and database users sync (#537)
* Add database and database users sync

* get mysl users

* add mariadb and postgres

* fix phpstan
2025-03-12 22:59:25 +01:00
493cbb0849 Add phpstan level 7(#544) 2025-03-12 13:31:10 +01:00
c22bb1fa80 Add isolated users to headless console (#533) 2025-03-07 00:14:45 +01:00
babf59350b Fix run_action helper (#540)
* Fix run_action helper

* upgrade actions

* upgrade actions
2025-03-05 20:36:18 +01:00
5a12ed76bb Database collations (#489)
* SyncDatabases

* Collation on Create inc WordPress

* Refactored Enum

* Resolve sync issue

* Fix for PostgreSQL

* pint

* reversed enum

* style adjustments

* add unit tests

* style

* fix tests

* more tests

---------

Co-authored-by: Saeed Vaziry <61919774+saeedvaziry@users.noreply.github.com>
Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
2025-03-02 17:18:27 +01:00
269ee8d962 Fix: Sail default container name to match docker-compose.yml (#532)
By default, Sail looks for the `laravel.test` container when running `sail artisan`, but the `docker-compose.yml` in this project defines the service as `app`. This caused `sail artisan` and other Sail commands to fail locally.

Updated the `APP_SERVICE` environment variable in `sail` to default to `app` instead of `laravel.test`, ensuring consistency with the service name in `docker-compose.yml`.
2025-03-02 14:06:58 +01:00
a060a06e73 add default commands 2025-03-02 12:08:18 +01:00
556 changed files with 16776 additions and 6991 deletions

42
.github/workflows/code-quality.yml vendored Normal file
View File

@ -0,0 +1,42 @@
name: code-quality
on:
push:
branches:
- 2.x
pull_request:
branches:
- 2.x
jobs:
tests:
runs-on: ubuntu-22.04
strategy:
fail-fast: true
matrix:
php: [ 8.2 ]
steps:
- uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
- name: Cache Composer packages
id: composer-cache
uses: actions/cache@v4
with:
path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-
- name: Install dependencies
if: steps.composer-cache.outputs.cache-hit != 'true'
run: composer install --prefer-dist --no-progress --no-suggest
- name: Run PHPStan
run: ./vendor/bin/phpstan analyse

View File

@ -19,7 +19,7 @@ jobs:
node-version: [ "20.x" ] node-version: [ "20.x" ]
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- name: Setup PHP - name: Setup PHP
uses: shivammathur/setup-php@v2 uses: shivammathur/setup-php@v2
@ -28,7 +28,7 @@ jobs:
- name: Cache Composer packages - name: Cache Composer packages
id: composer-cache id: composer-cache
uses: actions/cache@v2 uses: actions/cache@v4
with: with:
path: vendor path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
@ -43,7 +43,7 @@ jobs:
run: ./vendor/bin/pint --test run: ./vendor/bin/pint --test
- name: Setup Node.js - name: Setup Node.js
uses: actions/setup-node@v2 uses: actions/setup-node@v4
with: with:
node-version: "20.x" node-version: "20.x"

View File

@ -11,16 +11,16 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v2 uses: actions/checkout@v4
- name: Set up QEMU - name: Set up QEMU
uses: docker/setup-qemu-action@v1 uses: docker/setup-qemu-action@v2
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1 uses: docker/setup-buildx-action@v2
- name: Login to Docker Hub - name: Login to Docker Hub
uses: docker/login-action@v2 uses: docker/login-action@v3
with: with:
username: ${{ secrets.DOCKER_USERNAME }} username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }} password: ${{ secrets.DOCKER_PASSWORD }}

View File

@ -10,16 +10,16 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v2 uses: actions/checkout@v4
- name: Set up QEMU - name: Set up QEMU
uses: docker/setup-qemu-action@v1 uses: docker/setup-qemu-action@v2
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1 uses: docker/setup-buildx-action@v2
- name: Login to Docker Hub - name: Login to Docker Hub
uses: docker/login-action@v2 uses: docker/login-action@v3
with: with:
username: ${{ secrets.DOCKER_USERNAME }} username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }} password: ${{ secrets.DOCKER_PASSWORD }}

View File

@ -18,7 +18,7 @@ jobs:
php: [ 8.2 ] php: [ 8.2 ]
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- name: Setup PHP - name: Setup PHP
uses: shivammathur/setup-php@v2 uses: shivammathur/setup-php@v2
@ -27,12 +27,13 @@ jobs:
- name: Cache Composer packages - name: Cache Composer packages
id: composer-cache id: composer-cache
uses: actions/cache@v2 uses: actions/cache@v4
with: with:
path: vendor path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: | restore-keys: |
${{ runner.os }}-php- ${{ runner.os }}-php-
- name: Install dependencies - name: Install dependencies
if: steps.composer-cache.outputs.cache-hit != 'true' if: steps.composer-cache.outputs.cache-hit != 'true'
run: composer install --prefer-dist --no-progress --no-suggest run: composer install --prefer-dist --no-progress --no-suggest

View File

@ -35,7 +35,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -43,7 +43,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -60,7 +60,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer ge6ZVa4kfD86hdv5a31EcbP' - 'Bearer eDa6Vdh1Z4vc35bP8E6gafk'
controller: null controller: null
method: null method: null
route: null route: null
@ -97,7 +97,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -105,7 +105,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -113,7 +113,7 @@ endpoints:
name: command name: command
description: '' description: ''
required: true required: true
example: itaque example: quia
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -142,7 +142,7 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
command: itaque command: quia
user: root user: root
frequency: '* * * * *' frequency: '* * * * *'
fileParameters: [] fileParameters: []
@ -157,7 +157,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer cdh5bD8gVPkf34e1ZEva6a6' - 'Bearer 66EeZvdh3kVaDP8f4ga5c1b'
controller: null controller: null
method: null method: null
route: null route: null
@ -194,7 +194,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -204,7 +204,7 @@ endpoints:
name: cronJob_id name: cronJob_id
description: 'The ID of the cronJob.' description: 'The ID of the cronJob.'
required: true required: true
example: 18 example: 6
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -212,8 +212,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
cronJob_id: 18 cronJob_id: 6
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -230,7 +230,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer fa5VgdkaD8cZ6vh34Pb16eE' - 'Bearer D4c3Z65ebv8E16fahaVgPdk'
controller: null controller: null
method: null method: null
route: null route: null
@ -267,7 +267,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -277,7 +277,7 @@ endpoints:
name: cronJob_id name: cronJob_id
description: 'The ID of the cronJob.' description: 'The ID of the cronJob.'
required: true required: true
example: 10 example: 13
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -285,8 +285,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
cronJob_id: 10 cronJob_id: 13
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -303,7 +303,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P8hkva3ZD4fgb166adEVce5' - 'Bearer h3cP4aZa1v8feDdEg5b6k6V'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -35,7 +35,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -43,7 +43,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -52,7 +52,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"name":"amalia38","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"name":"troy.rippin","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"server_id":null,"name":"leffler.esther","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"name":"rhoda.rutherford","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -60,7 +60,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Z641ebPacDV6f38kEgdah5v' - 'Bearer E1VdfegZah4k86b53Dc6Pva'
controller: null controller: null
method: null method: null
route: null route: null
@ -97,7 +97,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -105,7 +105,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -113,19 +113,41 @@ endpoints:
name: name name: name
description: '' description: ''
required: true required: true
example: et example: quisquam
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
charset:
name: charset
description: ''
required: true
example: omnis
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
collation:
name: collation
description: ''
required: true
example: at
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: et name: quisquam
charset: omnis
collation: at
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"name":"harvey.haskell","status":"ready","created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"name":"csawayn","status":"ready","created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -133,7 +155,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer d4gbv56caV3aZ8D1h6kfEPe' - 'Bearer PVgkZ35ca4afd1EbD8ehv66'
controller: null controller: null
method: null method: null
route: null route: null
@ -170,7 +192,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -180,7 +202,7 @@ endpoints:
name: id name: id
description: 'The ID of the database.' description: 'The ID of the database.'
required: true required: true
example: 19 example: 8
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -188,8 +210,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
id: 19 id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -198,7 +220,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"name":"ruthie.koepp","status":"ready","created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"name":"sandrine43","status":"ready","created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -206,7 +228,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P68VgDcaEZvk63f4b5aed1h' - 'Bearer EP64D8g51adf6hbceavVZ3k'
controller: null controller: null
method: null method: null
route: null route: null
@ -243,7 +265,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -253,7 +275,7 @@ endpoints:
name: database_id name: database_id
description: 'The ID of the database.' description: 'The ID of the database.'
required: true required: true
example: 15 example: 8
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -261,8 +283,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
database_id: 15 database_id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -279,7 +301,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer DkPc6d1heEv5a8fb4V63agZ' - 'Bearer 8dgEk3Zv1eaVP66bDhf4ac5'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -35,7 +35,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -43,7 +43,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -52,7 +52,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"username":"xgaylord","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"username":"una37","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -60,7 +60,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P4gD36fZeckvVh5ab86Ead1' - 'Bearer d4g15bV3Pa6hDvck6eaEf8Z'
controller: null controller: null
method: null method: null
route: null route: null
@ -97,7 +97,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -105,7 +105,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -113,7 +113,7 @@ endpoints:
name: username name: username
description: '' description: ''
required: true required: true
example: consequuntur example: qui
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -123,7 +123,7 @@ endpoints:
name: password name: password
description: '' description: ''
required: true required: true
example: 'fI/i2.O4u&dla?eXvR2' example: 'xYv*3,#HQ=5<w!'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -140,14 +140,14 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
username: consequuntur username: qui
password: 'fI/i2.O4u&dla?eXvR2' password: 'xYv*3,#HQ=5<w!'
host: '%' host: '%'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"username":"kari.farrell","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"username":"marcelle95","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -155,7 +155,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 5k8Vced1baaE6f4ZvDPgh36' - 'Bearer 3vZ6f6kagacDEhV1Pde5b84'
controller: null controller: null
method: null method: null
route: null route: null
@ -192,7 +192,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -202,7 +202,7 @@ endpoints:
name: databaseUser_id name: databaseUser_id
description: 'The ID of the databaseUser.' description: 'The ID of the databaseUser.'
required: true required: true
example: 18 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -210,8 +210,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
databaseUser_id: 18 databaseUser_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -220,7 +220,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"username":"caterina.mosciski","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"username":"brandi53","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -228,7 +228,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3kDveP5V8a6dghfa4E16cbZ' - 'Bearer af3b5ac6dP8ZV4vE1hk6eDg'
controller: null controller: null
method: null method: null
route: null route: null
@ -265,7 +265,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -283,7 +283,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
databaseUser_id: 4 databaseUser_id: 4
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
@ -292,19 +292,19 @@ endpoints:
name: databases name: databases
description: 'Array of database names to link to the user.' description: 'Array of database names to link to the user.'
required: true required: true
example: non example: maiores
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
databases: non databases: maiores
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"username":"kurtis05","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"username":"kschmidt","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -312,7 +312,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer DgPea43EvV51a866dfbZckh' - 'Bearer b6f3Ed641gaZDcVa5k8vePh'
controller: null controller: null
method: null method: null
route: null route: null
@ -349,7 +349,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -359,7 +359,7 @@ endpoints:
name: databaseUser_id name: databaseUser_id
description: 'The ID of the databaseUser.' description: 'The ID of the databaseUser.'
required: true required: true
example: 6 example: 20
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -367,8 +367,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
databaseUser_id: 6 databaseUser_id: 20
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -385,7 +385,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 6ackVP8hEZd3164gD5evafb' - 'Bearer Zka6fh15g6eaV8vE34cDPdb'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -35,7 +35,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -43,7 +43,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -52,7 +52,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":38781,"source":"79.116.255.150","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":32141,"source":"52.174.114.251","mask":24,"note":"test","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"name":"ut","server_id":null,"type":"allow","protocol":"tcp","port":35499,"source":"177.130.54.250","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null},{"id":null,"name":"totam","server_id":null,"type":"allow","protocol":"tcp","port":29448,"source":"181.194.26.13","mask":24,"note":"test","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -60,7 +60,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer h3P5gD8E4dkeZ6abac6vfV1' - 'Bearer eD368kaZfVEab4v61ghdP5c'
controller: null controller: null
method: null method: null
route: null route: null
@ -97,7 +97,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -105,15 +105,25 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
name:
name: name
description: ''
required: true
example: sapiente
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
type: type:
name: type name: type
description: '' description: ''
required: true required: true
example: deny example: allow
type: string type: string
enumValues: enumValues:
- allow - allow
@ -125,7 +135,7 @@ endpoints:
name: protocol name: protocol
description: '' description: ''
required: true required: true
example: udp example: tcp
type: string type: string
enumValues: enumValues:
- tcp - tcp
@ -146,8 +156,8 @@ endpoints:
source: source:
name: source name: source
description: '' description: ''
required: true required: false
example: voluptates example: doloribus
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -164,16 +174,17 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
type: deny name: sapiente
protocol: udp type: allow
protocol: tcp
port: et port: et
source: voluptates source: doloribus
mask: '0' mask: '0'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":47148,"source":"119.182.8.45","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"name":"omnis","server_id":null,"type":"allow","protocol":"tcp","port":54634,"source":"246.242.9.65","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -181,7 +192,150 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 6a8DVv5k3gZfEe6hb1daPc4' - 'Bearer 3184PbED6aacZveV6hf5dgk'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- PUT
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
metadata:
groupName: firewall-rules
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: edit
description: 'Update an existing firewall rule.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
firewallRule_id:
name: firewallRule_id
description: 'The ID of the firewallRule.'
required: true
example: 85
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
firewallRule_id: 85
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: ''
required: true
example: et
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
type:
name: type
description: ''
required: true
example: allow
type: string
enumValues:
- allow
- deny
exampleWasSpecified: false
nullable: false
custom: []
protocol:
name: protocol
description: ''
required: true
example: tcp
type: string
enumValues:
- tcp
- udp
exampleWasSpecified: false
nullable: false
custom: []
port:
name: port
description: ''
required: true
example: aut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
source:
name: source
description: ''
required: false
example: et
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
mask:
name: mask
description: 'Mask for source IP.'
required: true
example: '0'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: et
type: allow
protocol: tcp
port: aut
source: et
mask: '0'
fileParameters: []
responses:
-
status: 200
content: '{"id":null,"name":"consequatur","server_id":null,"type":"allow","protocol":"tcp","port":879,"source":"206.106.27.116","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer ad46E3egPDc51aV6hb8vkZf'
controller: null controller: null
method: null method: null
route: null route: null
@ -218,7 +372,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -228,7 +382,7 @@ endpoints:
name: firewallRule_id name: firewallRule_id
description: 'The ID of the firewallRule.' description: 'The ID of the firewallRule.'
required: true required: true
example: 29 example: 85
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -236,8 +390,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
firewallRule_id: 29 firewallRule_id: 85
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -246,7 +400,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":2317,"source":"44.161.134.114","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"name":"dolores","server_id":null,"type":"allow","protocol":"tcp","port":4691,"source":"147.108.28.144","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -254,7 +408,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P4bZdV1geED3kfh568aa6cv' - 'Bearer 6gkvbDae15a6f43EVPdZh8c'
controller: null controller: null
method: null method: null
route: null route: null
@ -291,7 +445,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -301,7 +455,7 @@ endpoints:
name: firewallRule_id name: firewallRule_id
description: 'The ID of the firewallRule.' description: 'The ID of the firewallRule.'
required: true required: true
example: 29 example: 85
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -309,8 +463,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
firewallRule_id: 29 firewallRule_id: 85
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -327,7 +481,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Dh3kcaafdg6E5ZvV46ePb81' - 'Bearer ZVd1fk5E3e48hDvaa6g6cPb'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -29,7 +29,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"success":true,"version":"2.1.0"}' content: '{"success":true,"version":"2.4.0"}'
headers: headers:
cache-control: 'no-cache, private' cache-control: 'no-cache, private'
content-type: application/json content-type: application/json

View File

@ -30,7 +30,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":3,"name":"Jeffry Dickinson","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":4,"name":"Miss Tianna Dietrich PhD","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":3,"name":"Mr. Drake Nader","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"},{"id":4,"name":"Wilhelmine Jacobson","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -38,7 +38,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 5DaveP3d6b6khEZVcg4fa18' - 'Bearer fbPE6haeDZ8v1gV5ak463dc'
controller: null controller: null
method: null method: null
route: null route: null
@ -69,19 +69,19 @@ endpoints:
name: name name: name
description: 'The name of the project.' description: 'The name of the project.'
required: true required: true
example: quos example: dignissimos
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: quos name: dignissimos
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":3,"name":"Isidro Franecki","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":3,"name":"Pattie Cole","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -89,7 +89,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer a6P53EvkcZV6D4ghad1efb8' - 'Bearer 6ZkedcEfa5V6Dv4ab8P3g1h'
controller: null controller: null
method: null method: null
route: null route: null
@ -132,7 +132,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":3,"name":"Rhoda Parisian","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":3,"name":"Mr. Elias Bauch","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -140,7 +140,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer v48Ve5ZghdcbE1akP66fD3a' - 'Bearer P6ka4Zaefgh8Ec3dV15v6bD'
controller: null controller: null
method: null method: null
route: null route: null
@ -182,19 +182,19 @@ endpoints:
name: name name: name
description: 'The name of the project.' description: 'The name of the project.'
required: true required: true
example: ullam example: sunt
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: ullam name: sunt
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":3,"name":"Mr. Dashawn Jacobson Sr.","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":3,"name":"Elfrieda Jakubowski","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -202,7 +202,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer fvEdh3Vgbk56Z4a61eP8caD' - 'Bearer ecaDZkf5E4vgP1V86d6hb3a'
controller: null controller: null
method: null method: null
route: null route: null
@ -253,7 +253,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer eg4c3vZ1Dhaa68d6PEfk5bV' - 'Bearer h5gZ63DPVbcevE4faka86d1'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,19 +1,19 @@
## Autogenerated by Scribe. DO NOT MODIFY. ## Autogenerated by Scribe. DO NOT MODIFY.
name: servers name: redirects
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers' uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
metadata: metadata:
groupName: servers groupName: redirects
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: index
description: 'Get all servers in a project.' description: 'Get all redirects.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -31,8 +31,30 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
site_id:
name: site_id
description: 'The ID of the site.'
required: true
example: 44
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 29
site_id: 44
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -41,7 +63,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Amina DuBuque","ssh_user":"vito","ip":"163.77.69.73","local_ip":"137.139.200.70","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null},{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Floy Cummerata","ssh_user":"vito","ip":"62.53.140.25","local_ip":"34.59.35.195","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"site_id":null,"mode":307,"from":"ipsum","to":"http:\/\/fritsch.biz\/","status":"ready","created_at":null,"updated_at":null},{"id":null,"site_id":null,"mode":302,"from":"culpa","to":"http:\/\/www.huels.net\/aut-ut-ut-porro-non-rerum-voluptatum.html","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -49,7 +71,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer E81avahec6365dbZfgD4kPV' - 'Bearer cV16fevgEZhPadD43685akb'
controller: null controller: null
method: null method: null
route: null route: null
@ -57,14 +79,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/servers' uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
metadata: metadata:
groupName: servers groupName: redirects
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: create title: create
description: 'Create a new server.' description: 'Create a new redirect.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -82,288 +104,75 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
site_id:
name: site_id
description: 'The ID of the site.'
required: true
example: 44
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 29
site_id: 44
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
provider: from:
name: provider name: from
description: 'The server provider type' description: ''
required: true required: true
example: iste example: odit
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_provider: to:
name: server_provider name: to
description: 'If the provider is not custom, the ID of the server provider profile' description: ''
required: true required: true
example: custom example: incidunt
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
mode:
name: mode
description: ''
required: true
example: 301
type: string type: string
enumValues: enumValues:
- custom - 301
- hetzner - 302
- digitalocean - 307
- linode - 308
- vultr
exampleWasSpecified: false
nullable: false
custom: []
region:
name: region
description: 'Provider region if the provider is not custom'
required: true
example: libero
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
plan:
name: plan
description: 'Provider plan if the provider is not custom'
required: true
example: ut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
ip:
name: ip
description: 'SSH IP address if the provider is custom'
required: true
example: molestias
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
port:
name: port
description: 'SSH Port if the provider is custom'
required: true
example: laudantium
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
name:
name: name
description: 'The name of the server.'
required: true
example: illum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
os:
name: os
description: 'The os of the server'
required: true
example: autem
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
webserver:
name: webserver
description: 'Web server'
required: true
example: none
type: string
enumValues:
- none
- nginx
exampleWasSpecified: false
nullable: false
custom: []
database:
name: database
description: Database
required: true
example: postgresql12
type: string
enumValues:
- none
- mysql57
- mysql80
- mariadb103
- mariadb104
- mariadb103
- postgresql12
- postgresql13
- postgresql14
- postgresql15
- postgresql16
exampleWasSpecified: false
nullable: false
custom: []
php:
name: php
description: 'PHP version'
required: true
example: '7.4'
type: string
enumValues:
- '7.0'
- '7.1'
- '7.2'
- '7.3'
- '7.4'
- '8.0'
- '8.1'
- '8.2'
- '8.3'
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
provider: iste from: odit
server_provider: custom to: incidunt
region: libero mode: 301
plan: ut
ip: molestias
port: laudantium
name: illum
os: autem
webserver: none
database: postgresql12
php: '7.4'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Archibald Nolan","ssh_user":"vito","ip":"226.168.13.177","local_ip":"143.14.43.182","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer aad3Pvc4e65DghZVEk8f1b6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/projects/{project_id}/servers/{id}'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: show
description: 'Get a server by ID.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Tevin Sipes","ssh_user":"vito","ip":"61.41.183.152","local_ip":"197.160.239.147","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 5EhD3v6Z8Vdakfg46eP1cab'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/reboot'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: reboot
description: 'Reboot a server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null content: null
headers: [] headers: []
description: '' description: ''
@ -372,69 +181,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Pc5Da6Vhdk1vag6fE84e3Zb' - 'Bearer ZD45hPk638abev61EVcagdf'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/upgrade'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: upgrade
description: 'Upgrade server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer a61v48DfkeEbcg3a6hd5PZV'
controller: null controller: null
method: null method: null
route: null route: null
@ -442,14 +189,14 @@ endpoints:
- -
httpMethods: httpMethods:
- DELETE - DELETE
uri: 'api/projects/{project_id}/servers/{server_id}' uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects/{redirect_id}'
metadata: metadata:
groupName: servers groupName: redirects
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: delete
description: 'Delete server.' description: 'Delete a redirect.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -471,7 +218,27 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
site_id:
name: site_id
description: 'The ID of the site.'
required: true
example: 44
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
redirect_id:
name: redirect_id
description: 'The ID of the redirect.'
required: true
example: 9
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -479,7 +246,9 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
site_id: 44
redirect_id: 9
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -496,7 +265,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer haE8D6Z6gePk1vadVb53c4f' - 'Bearer Ec3fDgdbae615aPh8k6vV4Z'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,19 +1,19 @@
## Autogenerated by Scribe. DO NOT MODIFY. ## Autogenerated by Scribe. DO NOT MODIFY.
name: server-providers name: servers
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/server-providers' uri: 'api/projects/{project_id}/servers'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: '' description: 'Get all servers in a project.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -41,7 +41,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":2,"project_id":null,"global":true,"name":"laudantium","provider":"vultr","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":3,"project_id":null,"global":true,"name":"aut","provider":"aws","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Miss Bonita Vandervort IV","ssh_user":"vito","ip":"120.222.195.212","local_ip":"138.119.37.248","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null},{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Dr. Shanie Batz IV","ssh_user":"vito","ip":"241.88.138.163","local_ip":"138.226.232.93","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -49,7 +49,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Df16eda8Pa345EkgbZ6cvhV' - 'Bearer Pg1Vk6cvadD8eb3ZhaEf564'
controller: null controller: null
method: null method: null
route: null route: null
@ -57,14 +57,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/server-providers' uri: 'api/projects/{project_id}/servers'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: create title: create
description: '' description: 'Create a new server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -89,9 +89,64 @@ endpoints:
bodyParameters: bodyParameters:
provider: provider:
name: provider name: provider
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)' description: 'The server provider type'
required: true required: true
example: voluptatem example: fugiat
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_provider:
name: server_provider
description: 'If the provider is not custom, the ID of the server provider profile'
required: true
example: digitalocean
type: string
enumValues:
- custom
- hetzner
- digitalocean
- linode
- vultr
exampleWasSpecified: false
nullable: false
custom: []
region:
name: region
description: 'Provider region if the provider is not custom'
required: true
example: itaque
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
plan:
name: plan
description: 'Provider plan if the provider is not custom'
required: true
example: voluptatum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
ip:
name: ip
description: 'SSH IP address if the provider is custom'
required: true
example: ut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
port:
name: port
description: 'SSH Port if the provider is custom'
required: true
example: reiciendis
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -99,55 +154,93 @@ endpoints:
custom: [] custom: []
name: name:
name: name name: name
description: 'The name of the server provider.' description: 'The name of the server.'
required: true required: true
example: repellat example: et
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
token: os:
name: token name: os
description: 'The token if provider requires api token' description: 'The os of the server'
required: true required: true
example: omnis example: vel
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
key: webserver:
name: key name: webserver
description: 'The key if provider requires key' description: 'Web server'
required: true required: true
example: recusandae example: nginx
type: string type: string
enumValues: [] enumValues:
- none
- nginx
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
secret: database:
name: secret name: database
description: 'The secret if provider requires key' description: Database
required: true required: true
example: in example: mysql80
type: string type: string
enumValues: [] enumValues:
- none
- mysql57
- mysql80
- mariadb103
- mariadb104
- mariadb103
- postgresql12
- postgresql13
- postgresql14
- postgresql15
- postgresql16
exampleWasSpecified: false
nullable: false
custom: []
php:
name: php
description: 'PHP version'
required: true
example: '7.2'
type: string
enumValues:
- '7.0'
- '7.1'
- '7.2'
- '7.3'
- '7.4'
- '8.0'
- '8.1'
- '8.2'
- '8.3'
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
provider: voluptatem provider: fugiat
name: repellat server_provider: digitalocean
token: omnis region: itaque
key: recusandae plan: voluptatum
secret: in ip: ut
port: reiciendis
name: et
os: vel
webserver: nginx
database: mysql80
php: '7.2'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":2,"project_id":null,"global":true,"name":"quia","provider":"vultr","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Jeromy Mann","ssh_user":"vito","ip":"128.70.209.89","local_ip":"150.217.250.187","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -155,7 +248,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 8fbgDV6vdhakE1c64e3P5aZ' - 'Bearer 5E61e4vfcgDbVkZd68aah3P'
controller: null controller: null
method: null method: null
route: null route: null
@ -163,14 +256,14 @@ endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}' uri: 'api/projects/{project_id}/servers/{id}'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: show title: show
description: '' description: 'Get a server by ID.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -188,11 +281,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
serverProvider_id: id:
name: serverProvider_id name: id
description: 'The ID of the serverProvider.' description: 'The ID of the server.'
required: true required: true
example: 1 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -200,7 +293,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
serverProvider_id: 1 id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -209,7 +302,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":2,"project_id":null,"global":true,"name":"ab","provider":"hetzner","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Miss Maya Schaden I","ssh_user":"vito","ip":"44.57.83.39","local_ip":"46.22.92.58","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -217,22 +310,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer eVE816Pc4ak3bdfahDZv6g5' - 'Bearer hV3debf65aPD4E1ckag8Z6v'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- PUT - POST
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}' uri: 'api/projects/{project_id}/servers/{server_id}/reboot'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: update title: reboot
description: '' description: 'Reboot a server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -250,11 +343,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
serverProvider_id: server_id:
name: serverProvider_id name: server_id
description: 'The ID of the serverProvider.' description: 'The ID of the server.'
required: true required: true
example: 1 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -262,93 +355,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
serverProvider_id: 1 server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'The name of the server provider.'
required: true
example: est
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
global:
name: global
description: 'Accessible in all projects'
required: true
example: true
type: string
enumValues:
- true
- false
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: est
global: true
fileParameters: []
responses:
-
status: 200
content: '{"id":2,"project_id":null,"global":true,"name":"nesciunt","provider":"linode","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer va86keaPDdh3b16Z54EgfcV'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata:
groupName: server-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
serverProvider_id:
name: serverProvider_id
description: 'The ID of the serverProvider.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
serverProvider_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -365,7 +372,131 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer abv13ag8h5fZ4EPVDe6dc6k' - 'Bearer b61aD6538PacZEkeghfvV4d'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/upgrade'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: upgrade
description: 'Upgrade server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer dEZaa6cePVf3k86g45vbD1h'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/servers/{server_id}'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: 'Delete server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 6aDkZEfdP16V58gb43avhec'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,19 +1,19 @@
## Autogenerated by Scribe. DO NOT MODIFY. ## Autogenerated by Scribe. DO NOT MODIFY.
name: ssh-keys name: server-providers
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys' uri: 'api/projects/{project_id}/server-providers'
metadata: metadata:
groupName: ssh-keys groupName: server-providers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: 'Get all ssh keys.' description: ''
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -31,19 +31,8 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -52,7 +41,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"user":null,"name":"Godfrey Mills","created_at":null,"updated_at":null},{"id":null,"user":null,"name":"Donato Streich","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":3,"project_id":null,"global":true,"name":"aut","provider":"hetzner","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"},{"id":4,"project_id":null,"global":true,"name":"qui","provider":"aws","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -60,7 +49,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 1gEva8Z6e6abPDhk453fdVc' - 'Bearer 3evaP8h6VEZkbfgaD6d1c45'
controller: null controller: null
method: null method: null
route: null route: null
@ -68,14 +57,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys' uri: 'api/projects/{project_id}/server-providers'
metadata: metadata:
groupName: ssh-keys groupName: server-providers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: create title: create
description: 'Deploy ssh key to server.' description: ''
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -93,27 +82,16 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
key_id: provider:
name: key_id name: provider
description: 'The ID of the key.' description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)'
required: true required: true
example: numquam example: corrupti
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -121,33 +99,55 @@ endpoints:
custom: [] custom: []
name: name:
name: name name: name
description: 'Key name, required if key_id is not provided.' description: 'The name of the server provider.'
required: true required: true
example: alias example: est
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
public_key: token:
name: public_key name: token
description: 'Public Key, required if key_id is not provided.' description: 'The token if provider requires api token'
required: true required: true
example: voluptate example: rerum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
key:
name: key
description: 'The key if provider requires key'
required: true
example: ut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
secret:
name: secret
description: 'The secret if provider requires key'
required: true
example: sed
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
key_id: numquam provider: corrupti
name: alias name: est
public_key: voluptate token: rerum
key: ut
secret: sed
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"user":null,"name":"Mr. Stanton Bergnaum","created_at":null,"updated_at":null}' content: '{"id":3,"project_id":null,"global":true,"name":"voluptas","provider":"vultr","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -155,22 +155,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer V64Z86fEdbavh1PgackDe53' - 'Bearer 6g6vfEck83VaPhd5Zabe1D4'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- DELETE - GET
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys/{sshKey_id}' uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata: metadata:
groupName: ssh-keys groupName: server-providers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: show
description: 'Delete ssh key from server.' description: ''
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -188,19 +188,9 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id: serverProvider_id:
name: server_id name: serverProvider_id
description: 'The ID of the server.' description: 'The ID of the serverProvider.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
sshKey_id:
name: sshKey_id
description: 'The ID of the sshKey.'
required: true required: true
example: 1 example: 1
type: integer type: integer
@ -210,8 +200,155 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 serverProvider_id: 1
sshKey_id: 1 queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"id":3,"project_id":null,"global":true,"name":"et","provider":"digitalocean","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer va63cDe8dPf5Z4Vahb1E6kg'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- PUT
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata:
groupName: server-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: update
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
serverProvider_id:
name: serverProvider_id
description: 'The ID of the serverProvider.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
serverProvider_id: 1
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'The name of the server provider.'
required: true
example: earum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
global:
name: global
description: 'Accessible in all projects'
required: true
example: false
type: string
enumValues:
- true
- false
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: earum
global: false
fileParameters: []
responses:
-
status: 200
content: '{"id":3,"project_id":null,"global":true,"name":"architecto","provider":"digitalocean","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 4e1dghaV6D856P3ZbfkcEva'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata:
groupName: server-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
serverProvider_id:
name: serverProvider_id
description: 'The ID of the serverProvider.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
serverProvider_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -228,7 +365,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3deg1vc65k8D6abahfZVPE4' - 'Bearer fcVa8ev63gP5DaZbkdhE461'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,19 +1,19 @@
## Autogenerated by Scribe. DO NOT MODIFY. ## Autogenerated by Scribe. DO NOT MODIFY.
name: services name: ssh-keys
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/services' uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
metadata: metadata:
groupName: services groupName: ssh-keys
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: 'Get all services.' description: 'Get all ssh keys.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -35,7 +35,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -43,7 +43,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -52,7 +52,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -60,22 +60,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer cdhb5VevgkZ6DafP6184a3E' - 'Bearer 165aZvb46PhacEfke83dVgD'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- GET - POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}' uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
metadata: metadata:
groupName: services groupName: ssh-keys
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: show title: create
description: 'Get a service by ID.' description: 'Deploy ssh key to server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -97,17 +97,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the service.'
required: true
example: 53
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -115,17 +105,49 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
id: 53
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters:
cleanBodyParameters: [] key_id:
name: key_id
description: 'The ID of the key.'
required: true
example: explicabo
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
name:
name: name
description: 'Key name, required if key_id is not provided.'
required: true
example: deleniti
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
public_key:
name: public_key
description: 'Public Key, required if key_id is not provided.'
required: true
example: sapiente
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
key_id: explicabo
name: deleniti
public_key: sapiente
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null}' content: '{"id":null,"user":null,"name":"Mr. Reagan Jacobson V","created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -133,372 +155,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3vDaE6Pc51Zg8kbheadVf64' - 'Bearer deDkf4E13PZb6cgaV58ha6v'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: start
description: 'Start service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer a6e6Db5VcP314EgZdka8vhf'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/stop'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: stop
description: 'Stop service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer kefg56PEc4a18aDdvVZb3h6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/restart'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: restart
description: 'Restart service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer edhaE164avZ6gbVDPf3k8c5'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/enable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: enable
description: 'Enable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer D4c1hbfV6Pad68v3gEkaeZ5'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/disable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: disable
description: 'Disable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer be41fvh6a8d5PkDVEgZ36ca'
controller: null controller: null
method: null method: null
route: null route: null
@ -506,14 +163,14 @@ endpoints:
- -
httpMethods: httpMethods:
- DELETE - DELETE
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}' uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys/{sshKey_id}'
metadata: metadata:
groupName: services groupName: ssh-keys
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: delete
description: 'Delete service.' description: 'Delete ssh key from server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -535,17 +192,17 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
service_id: sshKey_id:
name: service_id name: sshKey_id
description: 'The ID of the service.' description: 'The ID of the sshKey.'
required: true required: true
example: 53 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -553,8 +210,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
service_id: 53 sshKey_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -571,7 +228,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer dcb68hg634P1DaZvef5VakE' - 'Bearer ec48fgVdZ6ah3kvPD16E5ab'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,19 +1,19 @@
## Autogenerated by Scribe. DO NOT MODIFY. ## Autogenerated by Scribe. DO NOT MODIFY.
name: sites name: services
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/sites' uri: 'api/projects/{project_id}/servers/{server_id}/services'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: 'Get all sites.' description: 'Get all services.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -35,7 +35,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -43,7 +43,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -52,7 +52,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -60,212 +60,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3gE54ahkea166PfvbVD8Zdc' - 'Bearer gVEce46k8aZfaP3d15vbhD6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/sites'
metadata:
groupName: sites
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: create
description: 'Create a new site.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters:
type:
name: type
description: ''
required: true
example: php
type: string
enumValues:
- php
- php-blank
- phpmyadmin
- laravel
- wordpress
- load-balancer
exampleWasSpecified: false
nullable: false
custom: []
domain:
name: domain
description: ''
required: true
example: rem
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
aliases:
name: aliases
description: ''
required: true
example:
- libero
type: 'string[]'
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
php_version:
name: php_version
description: 'One of the installed PHP Versions'
required: true
example: '7.4'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
web_directory:
name: web_directory
description: 'Required for PHP and Laravel sites'
required: true
example: public
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
source_control:
name: source_control
description: 'Source control ID, Required for Sites which support source control'
required: true
example: dolor
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
repository:
name: repository
description: 'Repository, Required for Sites which support source control'
required: true
example: organization/repository
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
branch:
name: branch
description: 'Branch, Required for Sites which support source control'
required: true
example: main
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
composer:
name: composer
description: 'Run composer if site supports composer'
required: true
example: true
type: boolean
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
version:
name: version
description: 'Version, if the site type requires a version like PHPMyAdmin'
required: true
example: 5.2.1
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
user:
name: user
description: 'user, to isolate the website under a new user'
required: true
example: vitae
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
method:
name: method
description: 'Load balancer method, Required if the site type is Load balancer'
required: true
example: ip-hash
type: string
enumValues:
- round-robin
- least-connections
- ip-hash
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
type: php
domain: rem
aliases:
- libero
php_version: '7.4'
web_directory: public
source_control: dolor
repository: organization/repository
branch: main
composer: true
version: 5.2.1
user: vitae
method: ip-hash
fileParameters: []
responses:
-
status: 200
content: '{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer e1V4ga3Pavk6ch6b5E8fZdD'
controller: null controller: null
method: null method: null
route: null route: null
@ -273,14 +68,14 @@ endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{id}' uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: show title: show
description: 'Get a site by ID.' description: 'Get a service by ID.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -302,7 +97,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -310,9 +105,9 @@ endpoints:
custom: [] custom: []
id: id:
name: id name: id
description: 'The ID of the site.' description: 'The ID of the service.'
required: true required: true
example: 26 example: 169
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -320,8 +115,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
id: 26 id: 169
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -330,7 +125,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -338,22 +133,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 8gZkEaehfd4v3bac615DVP6' - 'Bearer Ef8D5gbV6cadk3Zh1vP46ea'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- DELETE - POST
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}' uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: start
description: 'Delete site.' description: 'Start service.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -375,17 +170,17 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
site_id: service_id:
name: site_id name: service_id
description: 'The ID of the site.' description: 'The ID of the service.'
required: true required: true
example: 26 example: 169
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -393,8 +188,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
site_id: 26 service_id: 169
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -411,7 +206,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer aadb1h6f6kD4V8vePZgcE35' - 'Bearer b3DckZ8g6ha6aPe4f5V1vdE'
controller: null controller: null
method: null method: null
route: null route: null
@ -419,14 +214,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/load-balancer' uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/stop'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: load-balancer title: stop
description: 'Update load balancer.' description: 'Stop service.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -448,17 +243,17 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
site_id: service_id:
name: site_id name: service_id
description: 'The ID of the site.' description: 'The ID of the service.'
required: true required: true
example: 26 example: 169
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -466,43 +261,16 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
site_id: 26 service_id: 169
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters: []
method: cleanBodyParameters: []
name: method
description: 'Load balancer method, Required if the site type is Load balancer'
required: true
example: least-connections
type: string
enumValues:
- round-robin
- least-connections
- ip-hash
exampleWasSpecified: false
nullable: false
custom: []
servers:
name: servers
description: 'Array of servers including server, port, weight, backup. (server is the local IP of the server)'
required: true
example:
- deleniti
type: 'string[]'
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
method: least-connections
servers:
- deleniti
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 204
content: null content: null
headers: [] headers: []
description: '' description: ''
@ -511,7 +279,299 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 5E6hZa64bka1cV3Pdvf8Deg' - 'Bearer 1e8aZbfvE5643DacgkPhdV6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/restart'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: restart
description: 'Restart service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer c46baVZEg5dv1Pfe8Dha6k3'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/enable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: enable
description: 'Enable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer EvcehkDbdV43f61P86Za5ga'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/disable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: disable
description: 'Disable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer k8E5gf6d4h31bevaa6cVPZD'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: 'Delete service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer Pekav16cd5ag486ZfD3EVbh'
controller: null controller: null
method: null method: null
route: null route: null

File diff suppressed because it is too large Load Diff

View File

@ -1,14 +1,14 @@
## Autogenerated by Scribe. DO NOT MODIFY. ## Autogenerated by Scribe. DO NOT MODIFY.
name: storage-providers name: source-controls
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/storage-providers' uri: 'api/projects/{project_id}/source-controls'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -41,7 +41,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":5,"project_id":null,"global":true,"name":"dolorem","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":6,"project_id":null,"global":true,"name":"itaque","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":5,"project_id":null,"global":true,"name":"Zella Robel","provider":"github","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"},{"id":6,"project_id":null,"global":true,"name":"Jairo Williamson","provider":"github","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -49,7 +49,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer D16Vg58E6Pfkh3Zveab4dca' - 'Bearer e3f4ag8hkb5vZcDadPEV661'
controller: null controller: null
method: null method: null
route: null route: null
@ -57,9 +57,9 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/storage-providers' uri: 'api/projects/{project_id}/source-controls'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -89,11 +89,14 @@ endpoints:
bodyParameters: bodyParameters:
provider: provider:
name: provider name: provider
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)' description: 'The provider'
required: true required: true
example: alias example: gitlab
type: string type: string
enumValues: [] enumValues:
- gitlab
- github
- bitbucket
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
@ -101,7 +104,7 @@ endpoints:
name: name name: name
description: 'The name of the storage provider.' description: 'The name of the storage provider.'
required: true required: true
example: explicabo example: molestias
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -111,43 +114,54 @@ endpoints:
name: token name: token
description: 'The token if provider requires api token' description: 'The token if provider requires api token'
required: true required: true
example: ut example: in
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
key: url:
name: key name: url
description: 'The key if provider requires key' description: 'The URL if the provider is Gitlab and it is self-hosted'
required: true required: true
example: libero example: 'https://www.white.com/aperiam-dolor-nemo-qui-rerum-quod-quas'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
secret: username:
name: secret name: username
description: 'The secret if provider requires key' description: 'The username if the provider is Bitbucket'
required: true required: true
example: consequatur example: consectetur
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
password:
name: password
description: 'The password if the provider is Bitbucket'
required: true
example: 'y*P4_]ZdjE_:'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
provider: alias provider: gitlab
name: explicabo name: molestias
token: ut token: in
key: libero url: 'https://www.white.com/aperiam-dolor-nemo-qui-rerum-quod-quas'
secret: consequatur username: consectetur
password: 'y*P4_]ZdjE_:'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":5,"project_id":null,"global":true,"name":"quos","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":5,"project_id":null,"global":true,"name":"Miss Claudine Goyette","provider":"github","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -155,7 +169,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer DaZ6d6Eck1bhVe3g4aP85vf' - 'Bearer DfegP56vkEa364Zbhda8V1c'
controller: null controller: null
method: null method: null
route: null route: null
@ -163,9 +177,9 @@ endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}' uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -188,11 +202,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
storageProvider_id: sourceControl_id:
name: storageProvider_id name: sourceControl_id
description: 'The ID of the storageProvider.' description: 'The ID of the sourceControl.'
required: true required: true
example: 3 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -200,7 +214,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
storageProvider_id: 3 sourceControl_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -209,7 +223,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":5,"project_id":null,"global":true,"name":"id","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":5,"project_id":null,"global":true,"name":"Mona Stark","provider":"github","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -217,7 +231,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 1dekD4gva56bc683VPEhZfa' - 'Bearer ePc6fb65vh1Z4aakE3Dgd8V'
controller: null controller: null
method: null method: null
route: null route: null
@ -225,9 +239,9 @@ endpoints:
- -
httpMethods: httpMethods:
- PUT - PUT
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}' uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -250,11 +264,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
storageProvider_id: sourceControl_id:
name: storageProvider_id name: sourceControl_id
description: 'The ID of the storageProvider.' description: 'The ID of the sourceControl.'
required: true required: true
example: 3 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -262,7 +276,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
storageProvider_id: 3 sourceControl_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -270,7 +284,47 @@ endpoints:
name: name name: name
description: 'The name of the storage provider.' description: 'The name of the storage provider.'
required: true required: true
example: sequi example: non
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
token:
name: token
description: 'The token if provider requires api token'
required: true
example: sunt
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
url:
name: url
description: 'The URL if the provider is Gitlab and it is self-hosted'
required: true
example: 'https://www.frami.org/ex-at-minus-rerum-quo-minus-ea'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
username:
name: username
description: 'The username if the provider is Bitbucket'
required: true
example: natus
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
password:
name: password
description: 'The password if the provider is Bitbucket'
required: true
example: 'A^">*m{p]DI'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -280,7 +334,7 @@ endpoints:
name: global name: global
description: 'Accessible in all projects' description: 'Accessible in all projects'
required: true required: true
example: false example: true
type: string type: string
enumValues: enumValues:
- true - true
@ -289,13 +343,17 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: sequi name: non
global: false token: sunt
url: 'https://www.frami.org/ex-at-minus-rerum-quo-minus-ea'
username: natus
password: 'A^">*m{p]DI'
global: true
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":5,"project_id":null,"global":true,"name":"velit","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"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"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -303,7 +361,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer V65g18Pca4v3hDEkbZfe6da' - 'Bearer v3f6aaPk61Ze8hVdDbE5g4c'
controller: null controller: null
method: null method: null
route: null route: null
@ -311,9 +369,9 @@ endpoints:
- -
httpMethods: httpMethods:
- DELETE - DELETE
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}' uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -336,11 +394,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
storageProvider_id: sourceControl_id:
name: storageProvider_id name: sourceControl_id
description: 'The ID of the storageProvider.' description: 'The ID of the sourceControl.'
required: true required: true
example: 3 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -348,7 +406,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
storageProvider_id: 3 sourceControl_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -365,7 +423,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 1v6a6efgch3DbZ4aVE5d8kP' - 'Bearer fgk61vD68E4cZhP3bV5adea'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -0,0 +1,372 @@
## Autogenerated by Scribe. DO NOT MODIFY.
name: storage-providers
description: ''
endpoints:
-
httpMethods:
- GET
uri: 'api/projects/{project_id}/storage-providers'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: list
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer fgh4eV31dP58kvaDEaZbc66'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/storage-providers'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: create
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
queryParameters: []
cleanQueryParameters: []
bodyParameters:
provider:
name: provider
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)'
required: true
example: ab
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
name:
name: name
description: 'The name of the storage provider.'
required: true
example: quo
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
token:
name: token
description: 'The token if provider requires api token'
required: true
example: in
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
key:
name: key
description: 'The key if provider requires key'
required: true
example: sunt
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
secret:
name: secret
description: 'The secret if provider requires key'
required: true
example: molestias
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
provider: ab
name: quo
token: in
key: sunt
secret: molestias
fileParameters: []
responses:
-
status: 200
content: '{"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"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer e584613dkZaPDEVvgcahbf6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: show
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
storageProvider_id:
name: storageProvider_id
description: 'The ID of the storageProvider.'
required: true
example: 3
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
storageProvider_id: 3
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"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"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer h6Zk6834dDce5fbPa1VvagE'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- PUT
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: update
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
storageProvider_id:
name: storageProvider_id
description: 'The ID of the storageProvider.'
required: true
example: 3
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
storageProvider_id: 3
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'The name of the storage provider.'
required: true
example: voluptas
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
global:
name: global
description: 'Accessible in all projects'
required: true
example: true
type: string
enumValues:
- true
- false
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: voluptas
global: true
fileParameters: []
responses:
-
status: 200
content: '{"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"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer ak6fgd1Eba48chvPV3e5Z6D'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
storageProvider_id:
name: storageProvider_id
description: 'The ID of the storageProvider.'
required: true
example: 3
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
storageProvider_id: 3
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer PcaDbh6ZE4aV1e8fdv56k3g'
controller: null
method: null
route: null
custom: []

View File

@ -33,7 +33,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -41,7 +41,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -58,7 +58,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer ge6ZVa4kfD86hdv5a31EcbP' - 'Bearer eDa6Vdh1Z4vc35bP8E6gafk'
controller: null controller: null
method: null method: null
route: null route: null
@ -95,7 +95,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -103,7 +103,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -111,7 +111,7 @@ endpoints:
name: command name: command
description: '' description: ''
required: true required: true
example: itaque example: quia
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -140,7 +140,7 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
command: itaque command: quia
user: root user: root
frequency: '* * * * *' frequency: '* * * * *'
fileParameters: [] fileParameters: []
@ -155,7 +155,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer cdh5bD8gVPkf34e1ZEva6a6' - 'Bearer 66EeZvdh3kVaDP8f4ga5c1b'
controller: null controller: null
method: null method: null
route: null route: null
@ -192,7 +192,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -202,7 +202,7 @@ endpoints:
name: cronJob_id name: cronJob_id
description: 'The ID of the cronJob.' description: 'The ID of the cronJob.'
required: true required: true
example: 18 example: 6
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -210,8 +210,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
cronJob_id: 18 cronJob_id: 6
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -228,7 +228,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer fa5VgdkaD8cZ6vh34Pb16eE' - 'Bearer D4c3Z65ebv8E16fahaVgPdk'
controller: null controller: null
method: null method: null
route: null route: null
@ -265,7 +265,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -275,7 +275,7 @@ endpoints:
name: cronJob_id name: cronJob_id
description: 'The ID of the cronJob.' description: 'The ID of the cronJob.'
required: true required: true
example: 10 example: 13
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -283,8 +283,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
cronJob_id: 10 cronJob_id: 13
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -301,7 +301,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P8hkva3ZD4fgb166adEVce5' - 'Bearer h3cP4aZa1v8feDdEg5b6k6V'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -33,7 +33,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -41,7 +41,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -50,7 +50,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"name":"amalia38","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"name":"troy.rippin","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"server_id":null,"name":"leffler.esther","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"name":"rhoda.rutherford","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -58,7 +58,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Z641ebPacDV6f38kEgdah5v' - 'Bearer E1VdfegZah4k86b53Dc6Pva'
controller: null controller: null
method: null method: null
route: null route: null
@ -95,7 +95,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -103,7 +103,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -111,19 +111,41 @@ endpoints:
name: name name: name
description: '' description: ''
required: true required: true
example: et example: quisquam
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
charset:
name: charset
description: ''
required: true
example: omnis
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
collation:
name: collation
description: ''
required: true
example: at
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: et name: quisquam
charset: omnis
collation: at
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"name":"harvey.haskell","status":"ready","created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"name":"csawayn","status":"ready","created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -131,7 +153,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer d4gbv56caV3aZ8D1h6kfEPe' - 'Bearer PVgkZ35ca4afd1EbD8ehv66'
controller: null controller: null
method: null method: null
route: null route: null
@ -168,7 +190,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -178,7 +200,7 @@ endpoints:
name: id name: id
description: 'The ID of the database.' description: 'The ID of the database.'
required: true required: true
example: 19 example: 8
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -186,8 +208,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
id: 19 id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -196,7 +218,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"name":"ruthie.koepp","status":"ready","created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"name":"sandrine43","status":"ready","created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -204,7 +226,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P68VgDcaEZvk63f4b5aed1h' - 'Bearer EP64D8g51adf6hbceavVZ3k'
controller: null controller: null
method: null method: null
route: null route: null
@ -241,7 +263,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -251,7 +273,7 @@ endpoints:
name: database_id name: database_id
description: 'The ID of the database.' description: 'The ID of the database.'
required: true required: true
example: 15 example: 8
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -259,8 +281,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
database_id: 15 database_id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -277,7 +299,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer DkPc6d1heEv5a8fb4V63agZ' - 'Bearer 8dgEk3Zv1eaVP66bDhf4ac5'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -33,7 +33,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -41,7 +41,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -50,7 +50,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"username":"xgaylord","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"username":"una37","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -58,7 +58,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P4gD36fZeckvVh5ab86Ead1' - 'Bearer d4g15bV3Pa6hDvck6eaEf8Z'
controller: null controller: null
method: null method: null
route: null route: null
@ -95,7 +95,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -103,7 +103,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -111,7 +111,7 @@ endpoints:
name: username name: username
description: '' description: ''
required: true required: true
example: consequuntur example: qui
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -121,7 +121,7 @@ endpoints:
name: password name: password
description: '' description: ''
required: true required: true
example: 'fI/i2.O4u&dla?eXvR2' example: 'xYv*3,#HQ=5<w!'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -138,14 +138,14 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
username: consequuntur username: qui
password: 'fI/i2.O4u&dla?eXvR2' password: 'xYv*3,#HQ=5<w!'
host: '%' host: '%'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"username":"kari.farrell","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"username":"marcelle95","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -153,7 +153,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 5k8Vced1baaE6f4ZvDPgh36' - 'Bearer 3vZ6f6kagacDEhV1Pde5b84'
controller: null controller: null
method: null method: null
route: null route: null
@ -190,7 +190,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -200,7 +200,7 @@ endpoints:
name: databaseUser_id name: databaseUser_id
description: 'The ID of the databaseUser.' description: 'The ID of the databaseUser.'
required: true required: true
example: 18 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -208,8 +208,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
databaseUser_id: 18 databaseUser_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -218,7 +218,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"username":"caterina.mosciski","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"username":"brandi53","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -226,7 +226,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3kDveP5V8a6dghfa4E16cbZ' - 'Bearer af3b5ac6dP8ZV4vE1hk6eDg'
controller: null controller: null
method: null method: null
route: null route: null
@ -263,7 +263,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -281,7 +281,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
databaseUser_id: 4 databaseUser_id: 4
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
@ -290,19 +290,19 @@ endpoints:
name: databases name: databases
description: 'Array of database names to link to the user.' description: 'Array of database names to link to the user.'
required: true required: true
example: non example: maiores
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
databases: non databases: maiores
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"username":"kurtis05","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"username":"kschmidt","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -310,7 +310,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer DgPea43EvV51a866dfbZckh' - 'Bearer b6f3Ed641gaZDcVa5k8vePh'
controller: null controller: null
method: null method: null
route: null route: null
@ -347,7 +347,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -357,7 +357,7 @@ endpoints:
name: databaseUser_id name: databaseUser_id
description: 'The ID of the databaseUser.' description: 'The ID of the databaseUser.'
required: true required: true
example: 6 example: 20
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -365,8 +365,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
databaseUser_id: 6 databaseUser_id: 20
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -383,7 +383,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 6ackVP8hEZd3164gD5evafb' - 'Bearer Zka6fh15g6eaV8vE34cDPdb'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -33,7 +33,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -41,7 +41,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -50,7 +50,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":38781,"source":"79.116.255.150","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":32141,"source":"52.174.114.251","mask":24,"note":"test","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"name":"ut","server_id":null,"type":"allow","protocol":"tcp","port":35499,"source":"177.130.54.250","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null},{"id":null,"name":"totam","server_id":null,"type":"allow","protocol":"tcp","port":29448,"source":"181.194.26.13","mask":24,"note":"test","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -58,7 +58,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer h3P5gD8E4dkeZ6abac6vfV1' - 'Bearer eD368kaZfVEab4v61ghdP5c'
controller: null controller: null
method: null method: null
route: null route: null
@ -95,7 +95,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -103,15 +103,25 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
name:
name: name
description: ''
required: true
example: sapiente
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
type: type:
name: type name: type
description: '' description: ''
required: true required: true
example: deny example: allow
type: string type: string
enumValues: enumValues:
- allow - allow
@ -123,7 +133,7 @@ endpoints:
name: protocol name: protocol
description: '' description: ''
required: true required: true
example: udp example: tcp
type: string type: string
enumValues: enumValues:
- tcp - tcp
@ -144,8 +154,8 @@ endpoints:
source: source:
name: source name: source
description: '' description: ''
required: true required: false
example: voluptates example: doloribus
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -162,16 +172,17 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
type: deny name: sapiente
protocol: udp type: allow
protocol: tcp
port: et port: et
source: voluptates source: doloribus
mask: '0' mask: '0'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":47148,"source":"119.182.8.45","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"name":"omnis","server_id":null,"type":"allow","protocol":"tcp","port":54634,"source":"246.242.9.65","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -179,7 +190,150 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 6a8DVv5k3gZfEe6hb1daPc4' - 'Bearer 3184PbED6aacZveV6hf5dgk'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- PUT
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
metadata:
groupName: firewall-rules
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: edit
description: 'Update an existing firewall rule.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
firewallRule_id:
name: firewallRule_id
description: 'The ID of the firewallRule.'
required: true
example: 85
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
firewallRule_id: 85
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: ''
required: true
example: et
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
type:
name: type
description: ''
required: true
example: allow
type: string
enumValues:
- allow
- deny
exampleWasSpecified: false
nullable: false
custom: []
protocol:
name: protocol
description: ''
required: true
example: tcp
type: string
enumValues:
- tcp
- udp
exampleWasSpecified: false
nullable: false
custom: []
port:
name: port
description: ''
required: true
example: aut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
source:
name: source
description: ''
required: false
example: et
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
mask:
name: mask
description: 'Mask for source IP.'
required: true
example: '0'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: et
type: allow
protocol: tcp
port: aut
source: et
mask: '0'
fileParameters: []
responses:
-
status: 200
content: '{"id":null,"name":"consequatur","server_id":null,"type":"allow","protocol":"tcp","port":879,"source":"206.106.27.116","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer ad46E3egPDc51aV6hb8vkZf'
controller: null controller: null
method: null method: null
route: null route: null
@ -216,7 +370,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -226,7 +380,7 @@ endpoints:
name: firewallRule_id name: firewallRule_id
description: 'The ID of the firewallRule.' description: 'The ID of the firewallRule.'
required: true required: true
example: 29 example: 85
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -234,8 +388,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
firewallRule_id: 29 firewallRule_id: 85
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -244,7 +398,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"type":"allow","protocol":"tcp","port":2317,"source":"44.161.134.114","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}' content: '{"id":null,"name":"dolores","server_id":null,"type":"allow","protocol":"tcp","port":4691,"source":"147.108.28.144","mask":24,"note":"test","status":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -252,7 +406,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer P4bZdV1geED3kfh568aa6cv' - 'Bearer 6gkvbDae15a6f43EVPdZh8c'
controller: null controller: null
method: null method: null
route: null route: null
@ -289,7 +443,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -299,7 +453,7 @@ endpoints:
name: firewallRule_id name: firewallRule_id
description: 'The ID of the firewallRule.' description: 'The ID of the firewallRule.'
required: true required: true
example: 29 example: 85
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -307,8 +461,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
firewallRule_id: 29 firewallRule_id: 85
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -325,7 +479,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Dh3kcaafdg6E5ZvV46ePb81' - 'Bearer ZVd1fk5E3e48hDvaa6g6cPb'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -27,7 +27,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"success":true,"version":"2.1.0"}' content: '{"success":true,"version":"2.4.0"}'
headers: headers:
cache-control: 'no-cache, private' cache-control: 'no-cache, private'
content-type: application/json content-type: application/json

View File

@ -28,7 +28,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":3,"name":"Jeffry Dickinson","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":4,"name":"Miss Tianna Dietrich PhD","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":3,"name":"Mr. Drake Nader","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"},{"id":4,"name":"Wilhelmine Jacobson","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -36,7 +36,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 5DaveP3d6b6khEZVcg4fa18' - 'Bearer fbPE6haeDZ8v1gV5ak463dc'
controller: null controller: null
method: null method: null
route: null route: null
@ -67,19 +67,19 @@ endpoints:
name: name name: name
description: 'The name of the project.' description: 'The name of the project.'
required: true required: true
example: quos example: dignissimos
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: quos name: dignissimos
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":3,"name":"Isidro Franecki","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":3,"name":"Pattie Cole","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -87,7 +87,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer a6P53EvkcZV6D4ghad1efb8' - 'Bearer 6ZkedcEfa5V6Dv4ab8P3g1h'
controller: null controller: null
method: null method: null
route: null route: null
@ -130,7 +130,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":3,"name":"Rhoda Parisian","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":3,"name":"Mr. Elias Bauch","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -138,7 +138,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer v48Ve5ZghdcbE1akP66fD3a' - 'Bearer P6ka4Zaefgh8Ec3dV15v6bD'
controller: null controller: null
method: null method: null
route: null route: null
@ -180,19 +180,19 @@ endpoints:
name: name name: name
description: 'The name of the project.' description: 'The name of the project.'
required: true required: true
example: ullam example: sunt
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: ullam name: sunt
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":3,"name":"Mr. Dashawn Jacobson Sr.","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":3,"name":"Elfrieda Jakubowski","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -200,7 +200,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer fvEdh3Vgbk56Z4a61eP8caD' - 'Bearer ecaDZkf5E4vgP1V86d6hb3a'
controller: null controller: null
method: null method: null
route: null route: null
@ -251,7 +251,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer eg4c3vZ1Dhaa68d6PEfk5bV' - 'Bearer h5gZ63DPVbcevE4faka86d1'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,17 +1,17 @@
name: servers name: redirects
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers' uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
metadata: metadata:
groupName: servers groupName: redirects
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: index
description: 'Get all servers in a project.' description: 'Get all redirects.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -29,8 +29,30 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
site_id:
name: site_id
description: 'The ID of the site.'
required: true
example: 44
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 29
site_id: 44
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -39,7 +61,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Amina DuBuque","ssh_user":"vito","ip":"163.77.69.73","local_ip":"137.139.200.70","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null},{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Floy Cummerata","ssh_user":"vito","ip":"62.53.140.25","local_ip":"34.59.35.195","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"site_id":null,"mode":307,"from":"ipsum","to":"http:\/\/fritsch.biz\/","status":"ready","created_at":null,"updated_at":null},{"id":null,"site_id":null,"mode":302,"from":"culpa","to":"http:\/\/www.huels.net\/aut-ut-ut-porro-non-rerum-voluptatum.html","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -47,7 +69,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer E81avahec6365dbZfgD4kPV' - 'Bearer cV16fevgEZhPadD43685akb'
controller: null controller: null
method: null method: null
route: null route: null
@ -55,14 +77,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/servers' uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
metadata: metadata:
groupName: servers groupName: redirects
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: create title: create
description: 'Create a new server.' description: 'Create a new redirect.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -80,288 +102,75 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
site_id:
name: site_id
description: 'The ID of the site.'
required: true
example: 44
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 29
site_id: 44
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
provider: from:
name: provider name: from
description: 'The server provider type' description: ''
required: true required: true
example: iste example: odit
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_provider: to:
name: server_provider name: to
description: 'If the provider is not custom, the ID of the server provider profile' description: ''
required: true required: true
example: custom example: incidunt
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
mode:
name: mode
description: ''
required: true
example: 301
type: string type: string
enumValues: enumValues:
- custom - 301
- hetzner - 302
- digitalocean - 307
- linode - 308
- vultr
exampleWasSpecified: false
nullable: false
custom: []
region:
name: region
description: 'Provider region if the provider is not custom'
required: true
example: libero
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
plan:
name: plan
description: 'Provider plan if the provider is not custom'
required: true
example: ut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
ip:
name: ip
description: 'SSH IP address if the provider is custom'
required: true
example: molestias
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
port:
name: port
description: 'SSH Port if the provider is custom'
required: true
example: laudantium
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
name:
name: name
description: 'The name of the server.'
required: true
example: illum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
os:
name: os
description: 'The os of the server'
required: true
example: autem
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
webserver:
name: webserver
description: 'Web server'
required: true
example: none
type: string
enumValues:
- none
- nginx
exampleWasSpecified: false
nullable: false
custom: []
database:
name: database
description: Database
required: true
example: postgresql12
type: string
enumValues:
- none
- mysql57
- mysql80
- mariadb103
- mariadb104
- mariadb103
- postgresql12
- postgresql13
- postgresql14
- postgresql15
- postgresql16
exampleWasSpecified: false
nullable: false
custom: []
php:
name: php
description: 'PHP version'
required: true
example: '7.4'
type: string
enumValues:
- '7.0'
- '7.1'
- '7.2'
- '7.3'
- '7.4'
- '8.0'
- '8.1'
- '8.2'
- '8.3'
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
provider: iste from: odit
server_provider: custom to: incidunt
region: libero mode: 301
plan: ut
ip: molestias
port: laudantium
name: illum
os: autem
webserver: none
database: postgresql12
php: '7.4'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Archibald Nolan","ssh_user":"vito","ip":"226.168.13.177","local_ip":"143.14.43.182","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer aad3Pvc4e65DghZVEk8f1b6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/projects/{project_id}/servers/{id}'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: show
description: 'Get a server by ID.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Tevin Sipes","ssh_user":"vito","ip":"61.41.183.152","local_ip":"197.160.239.147","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 5EhD3v6Z8Vdakfg46eP1cab'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/reboot'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: reboot
description: 'Reboot a server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null content: null
headers: [] headers: []
description: '' description: ''
@ -370,69 +179,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Pc5Da6Vhdk1vag6fE84e3Zb' - 'Bearer ZD45hPk638abev61EVcagdf'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/upgrade'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: upgrade
description: 'Upgrade server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer a61v48DfkeEbcg3a6hd5PZV'
controller: null controller: null
method: null method: null
route: null route: null
@ -440,14 +187,14 @@ endpoints:
- -
httpMethods: httpMethods:
- DELETE - DELETE
uri: 'api/projects/{project_id}/servers/{server_id}' uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects/{redirect_id}'
metadata: metadata:
groupName: servers groupName: redirects
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: delete
description: 'Delete server.' description: 'Delete a redirect.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -469,7 +216,27 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
site_id:
name: site_id
description: 'The ID of the site.'
required: true
example: 44
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
redirect_id:
name: redirect_id
description: 'The ID of the redirect.'
required: true
example: 9
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -477,7 +244,9 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
site_id: 44
redirect_id: 9
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -494,7 +263,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer haE8D6Z6gePk1vadVb53c4f' - 'Bearer Ec3fDgdbae615aPh8k6vV4Z'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,17 +1,17 @@
name: server-providers name: servers
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/server-providers' uri: 'api/projects/{project_id}/servers'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: '' description: 'Get all servers in a project.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -39,7 +39,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":2,"project_id":null,"global":true,"name":"laudantium","provider":"vultr","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":3,"project_id":null,"global":true,"name":"aut","provider":"aws","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Miss Bonita Vandervort IV","ssh_user":"vito","ip":"120.222.195.212","local_ip":"138.119.37.248","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null},{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Dr. Shanie Batz IV","ssh_user":"vito","ip":"241.88.138.163","local_ip":"138.226.232.93","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -47,7 +47,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer Df16eda8Pa345EkgbZ6cvhV' - 'Bearer Pg1Vk6cvadD8eb3ZhaEf564'
controller: null controller: null
method: null method: null
route: null route: null
@ -55,14 +55,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/server-providers' uri: 'api/projects/{project_id}/servers'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: create title: create
description: '' description: 'Create a new server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -87,9 +87,64 @@ endpoints:
bodyParameters: bodyParameters:
provider: provider:
name: provider name: provider
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)' description: 'The server provider type'
required: true required: true
example: voluptatem example: fugiat
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_provider:
name: server_provider
description: 'If the provider is not custom, the ID of the server provider profile'
required: true
example: digitalocean
type: string
enumValues:
- custom
- hetzner
- digitalocean
- linode
- vultr
exampleWasSpecified: false
nullable: false
custom: []
region:
name: region
description: 'Provider region if the provider is not custom'
required: true
example: itaque
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
plan:
name: plan
description: 'Provider plan if the provider is not custom'
required: true
example: voluptatum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
ip:
name: ip
description: 'SSH IP address if the provider is custom'
required: true
example: ut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
port:
name: port
description: 'SSH Port if the provider is custom'
required: true
example: reiciendis
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -97,55 +152,93 @@ endpoints:
custom: [] custom: []
name: name:
name: name name: name
description: 'The name of the server provider.' description: 'The name of the server.'
required: true required: true
example: repellat example: et
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
token: os:
name: token name: os
description: 'The token if provider requires api token' description: 'The os of the server'
required: true required: true
example: omnis example: vel
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
key: webserver:
name: key name: webserver
description: 'The key if provider requires key' description: 'Web server'
required: true required: true
example: recusandae example: nginx
type: string type: string
enumValues: [] enumValues:
- none
- nginx
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
secret: database:
name: secret name: database
description: 'The secret if provider requires key' description: Database
required: true required: true
example: in example: mysql80
type: string type: string
enumValues: [] enumValues:
- none
- mysql57
- mysql80
- mariadb103
- mariadb104
- mariadb103
- postgresql12
- postgresql13
- postgresql14
- postgresql15
- postgresql16
exampleWasSpecified: false
nullable: false
custom: []
php:
name: php
description: 'PHP version'
required: true
example: '7.2'
type: string
enumValues:
- '7.0'
- '7.1'
- '7.2'
- '7.3'
- '7.4'
- '8.0'
- '8.1'
- '8.2'
- '8.3'
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
provider: voluptatem provider: fugiat
name: repellat server_provider: digitalocean
token: omnis region: itaque
key: recusandae plan: voluptatum
secret: in ip: ut
port: reiciendis
name: et
os: vel
webserver: nginx
database: mysql80
php: '7.2'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":2,"project_id":null,"global":true,"name":"quia","provider":"vultr","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Jeromy Mann","ssh_user":"vito","ip":"128.70.209.89","local_ip":"150.217.250.187","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -153,7 +246,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 8fbgDV6vdhakE1c64e3P5aZ' - 'Bearer 5E61e4vfcgDbVkZd68aah3P'
controller: null controller: null
method: null method: null
route: null route: null
@ -161,14 +254,14 @@ endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}' uri: 'api/projects/{project_id}/servers/{id}'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: show title: show
description: '' description: 'Get a server by ID.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -186,11 +279,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
serverProvider_id: id:
name: serverProvider_id name: id
description: 'The ID of the serverProvider.' description: 'The ID of the server.'
required: true required: true
example: 1 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -198,7 +291,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
serverProvider_id: 1 id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -207,7 +300,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":2,"project_id":null,"global":true,"name":"ab","provider":"hetzner","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Miss Maya Schaden I","ssh_user":"vito","ip":"44.57.83.39","local_ip":"46.22.92.58","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -215,22 +308,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer eVE816Pc4ak3bdfahDZv6g5' - 'Bearer hV3debf65aPD4E1ckag8Z6v'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- PUT - POST
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}' uri: 'api/projects/{project_id}/servers/{server_id}/reboot'
metadata: metadata:
groupName: server-providers groupName: servers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: update title: reboot
description: '' description: 'Reboot a server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -248,11 +341,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
serverProvider_id: server_id:
name: serverProvider_id name: server_id
description: 'The ID of the serverProvider.' description: 'The ID of the server.'
required: true required: true
example: 1 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -260,93 +353,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
serverProvider_id: 1 server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'The name of the server provider.'
required: true
example: est
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
global:
name: global
description: 'Accessible in all projects'
required: true
example: true
type: string
enumValues:
- true
- false
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: est
global: true
fileParameters: []
responses:
-
status: 200
content: '{"id":2,"project_id":null,"global":true,"name":"nesciunt","provider":"linode","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer va86keaPDdh3b16Z54EgfcV'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata:
groupName: server-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
serverProvider_id:
name: serverProvider_id
description: 'The ID of the serverProvider.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
serverProvider_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -363,7 +370,131 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer abv13ag8h5fZ4EPVDe6dc6k' - 'Bearer b61aD6538PacZEkeghfvV4d'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/upgrade'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: upgrade
description: 'Upgrade server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer dEZaa6cePVf3k86g45vbD1h'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/servers/{server_id}'
metadata:
groupName: servers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: 'Delete server.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 6aDkZEfdP16V58gb43avhec'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,17 +1,17 @@
name: ssh-keys name: server-providers
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys' uri: 'api/projects/{project_id}/server-providers'
metadata: metadata:
groupName: ssh-keys groupName: server-providers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: 'Get all ssh keys.' description: ''
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -29,19 +29,8 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -50,7 +39,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"user":null,"name":"Godfrey Mills","created_at":null,"updated_at":null},{"id":null,"user":null,"name":"Donato Streich","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":3,"project_id":null,"global":true,"name":"aut","provider":"hetzner","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"},{"id":4,"project_id":null,"global":true,"name":"qui","provider":"aws","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -58,7 +47,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 1gEva8Z6e6abPDhk453fdVc' - 'Bearer 3evaP8h6VEZkbfgaD6d1c45'
controller: null controller: null
method: null method: null
route: null route: null
@ -66,14 +55,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys' uri: 'api/projects/{project_id}/server-providers'
metadata: metadata:
groupName: ssh-keys groupName: server-providers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: create title: create
description: 'Deploy ssh key to server.' description: ''
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -91,27 +80,16 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
key_id: provider:
name: key_id name: provider
description: 'The ID of the key.' description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)'
required: true required: true
example: numquam example: corrupti
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -119,33 +97,55 @@ endpoints:
custom: [] custom: []
name: name:
name: name name: name
description: 'Key name, required if key_id is not provided.' description: 'The name of the server provider.'
required: true required: true
example: alias example: est
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
public_key: token:
name: public_key name: token
description: 'Public Key, required if key_id is not provided.' description: 'The token if provider requires api token'
required: true required: true
example: voluptate example: rerum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
key:
name: key
description: 'The key if provider requires key'
required: true
example: ut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
secret:
name: secret
description: 'The secret if provider requires key'
required: true
example: sed
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
key_id: numquam provider: corrupti
name: alias name: est
public_key: voluptate token: rerum
key: ut
secret: sed
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"user":null,"name":"Mr. Stanton Bergnaum","created_at":null,"updated_at":null}' content: '{"id":3,"project_id":null,"global":true,"name":"voluptas","provider":"vultr","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -153,22 +153,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer V64Z86fEdbavh1PgackDe53' - 'Bearer 6g6vfEck83VaPhd5Zabe1D4'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- DELETE - GET
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys/{sshKey_id}' uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata: metadata:
groupName: ssh-keys groupName: server-providers
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: show
description: 'Delete ssh key from server.' description: ''
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -186,19 +186,9 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
server_id: serverProvider_id:
name: server_id name: serverProvider_id
description: 'The ID of the server.' description: 'The ID of the serverProvider.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
sshKey_id:
name: sshKey_id
description: 'The ID of the sshKey.'
required: true required: true
example: 1 example: 1
type: integer type: integer
@ -208,8 +198,155 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 serverProvider_id: 1
sshKey_id: 1 queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"id":3,"project_id":null,"global":true,"name":"et","provider":"digitalocean","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer va63cDe8dPf5Z4Vahb1E6kg'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- PUT
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata:
groupName: server-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: update
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
serverProvider_id:
name: serverProvider_id
description: 'The ID of the serverProvider.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
serverProvider_id: 1
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'The name of the server provider.'
required: true
example: earum
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
global:
name: global
description: 'Accessible in all projects'
required: true
example: false
type: string
enumValues:
- true
- false
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: earum
global: false
fileParameters: []
responses:
-
status: 200
content: '{"id":3,"project_id":null,"global":true,"name":"architecto","provider":"digitalocean","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer 4e1dghaV6D856P3ZbfkcEva'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
metadata:
groupName: server-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
serverProvider_id:
name: serverProvider_id
description: 'The ID of the serverProvider.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
serverProvider_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -226,7 +363,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3deg1vc65k8D6abahfZVPE4' - 'Bearer fcVa8ev63gP5DaZbkdhE461'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,17 +1,17 @@
name: services name: ssh-keys
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/services' uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
metadata: metadata:
groupName: services groupName: ssh-keys
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: 'Get all services.' description: 'Get all ssh keys.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -33,7 +33,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -41,7 +41,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -50,7 +50,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -58,22 +58,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer cdhb5VevgkZ6DafP6184a3E' - 'Bearer 165aZvb46PhacEfke83dVgD'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- GET - POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}' uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
metadata: metadata:
groupName: services groupName: ssh-keys
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: show title: create
description: 'Get a service by ID.' description: 'Deploy ssh key to server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -95,17 +95,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
id:
name: id
description: 'The ID of the service.'
required: true
example: 53
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -113,17 +103,49 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
id: 53
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters:
cleanBodyParameters: [] key_id:
name: key_id
description: 'The ID of the key.'
required: true
example: explicabo
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
name:
name: name
description: 'Key name, required if key_id is not provided.'
required: true
example: deleniti
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
public_key:
name: public_key
description: 'Public Key, required if key_id is not provided.'
required: true
example: sapiente
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
key_id: explicabo
name: deleniti
public_key: sapiente
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null}' content: '{"id":null,"user":null,"name":"Mr. Reagan Jacobson V","created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -131,372 +153,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3vDaE6Pc51Zg8kbheadVf64' - 'Bearer deDkf4E13PZb6cgaV58ha6v'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: start
description: 'Start service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer a6e6Db5VcP314EgZdka8vhf'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/stop'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: stop
description: 'Stop service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer kefg56PEc4a18aDdvVZb3h6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/restart'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: restart
description: 'Restart service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer edhaE164avZ6gbVDPf3k8c5'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/enable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: enable
description: 'Enable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer D4c1hbfV6Pad68v3gEkaeZ5'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/disable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: disable
description: 'Disable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 53
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
service_id: 53
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer be41fvh6a8d5PkDVEgZ36ca'
controller: null controller: null
method: null method: null
route: null route: null
@ -504,14 +161,14 @@ endpoints:
- -
httpMethods: httpMethods:
- DELETE - DELETE
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}' uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys/{sshKey_id}'
metadata: metadata:
groupName: services groupName: ssh-keys
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: delete
description: 'Delete service.' description: 'Delete ssh key from server.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -533,17 +190,17 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
service_id: sshKey_id:
name: service_id name: sshKey_id
description: 'The ID of the service.' description: 'The ID of the sshKey.'
required: true required: true
example: 53 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -551,8 +208,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
service_id: 53 sshKey_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -569,7 +226,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer dcb68hg634P1DaZvef5VakE' - 'Bearer ec48fgVdZ6ah3kvPD16E5ab'
controller: null controller: null
method: null method: null
route: null route: null

View File

@ -1,17 +1,17 @@
name: sites name: services
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/sites' uri: 'api/projects/{project_id}/servers/{server_id}/services'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: list title: list
description: 'Get all sites.' description: 'Get all services.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -33,7 +33,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -41,7 +41,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -50,7 +50,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null},{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -58,212 +58,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 3gE54ahkea166PfvbVD8Zdc' - 'Bearer gVEce46k8aZfaP3d15vbhD6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/sites'
metadata:
groupName: sites
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: create
description: 'Create a new site.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
queryParameters: []
cleanQueryParameters: []
bodyParameters:
type:
name: type
description: ''
required: true
example: php
type: string
enumValues:
- php
- php-blank
- phpmyadmin
- laravel
- wordpress
- load-balancer
exampleWasSpecified: false
nullable: false
custom: []
domain:
name: domain
description: ''
required: true
example: rem
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
aliases:
name: aliases
description: ''
required: true
example:
- libero
type: 'string[]'
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
php_version:
name: php_version
description: 'One of the installed PHP Versions'
required: true
example: '7.4'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
web_directory:
name: web_directory
description: 'Required for PHP and Laravel sites'
required: true
example: public
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
source_control:
name: source_control
description: 'Source control ID, Required for Sites which support source control'
required: true
example: dolor
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
repository:
name: repository
description: 'Repository, Required for Sites which support source control'
required: true
example: organization/repository
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
branch:
name: branch
description: 'Branch, Required for Sites which support source control'
required: true
example: main
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
composer:
name: composer
description: 'Run composer if site supports composer'
required: true
example: true
type: boolean
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
version:
name: version
description: 'Version, if the site type requires a version like PHPMyAdmin'
required: true
example: 5.2.1
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
user:
name: user
description: 'user, to isolate the website under a new user'
required: true
example: vitae
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
method:
name: method
description: 'Load balancer method, Required if the site type is Load balancer'
required: true
example: ip-hash
type: string
enumValues:
- round-robin
- least-connections
- ip-hash
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
type: php
domain: rem
aliases:
- libero
php_version: '7.4'
web_directory: public
source_control: dolor
repository: organization/repository
branch: main
composer: true
version: 5.2.1
user: vitae
method: ip-hash
fileParameters: []
responses:
-
status: 200
content: '{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer e1V4ga3Pavk6ch6b5E8fZdD'
controller: null controller: null
method: null method: null
route: null route: null
@ -271,14 +66,14 @@ endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{id}' uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: show title: show
description: 'Get a site by ID.' description: 'Get a service by ID.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -300,7 +95,7 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -308,9 +103,9 @@ endpoints:
custom: [] custom: []
id: id:
name: id name: id
description: 'The ID of the site.' description: 'The ID of the service.'
required: true required: true
example: 26 example: 169
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -318,8 +113,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
id: 26 id: 169
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -328,7 +123,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":null,"server_id":null,"source_control_id":null,"type":"laravel","type_data":null,"domain":"test.com","aliases":null,"web_directory":"\/","path":"\/home","php_version":"8.2","repository":null,"branch":"main","status":"ready","port":null,"user":"vito","progress":100,"created_at":null,"updated_at":null}' content: '{"id":null,"server_id":null,"type":null,"type_data":null,"name":null,"version":null,"unit":null,"status":null,"is_default":null,"created_at":null,"updated_at":null}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -336,22 +131,22 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 8gZkEaehfd4v3bac615DVP6' - 'Bearer Ef8D5gbV6cadk3Zh1vP46ea'
controller: null controller: null
method: null method: null
route: null route: null
custom: [] custom: []
- -
httpMethods: httpMethods:
- DELETE - POST
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}' uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: delete title: start
description: 'Delete site.' description: 'Start service.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -373,17 +168,17 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
site_id: service_id:
name: site_id name: service_id
description: 'The ID of the site.' description: 'The ID of the service.'
required: true required: true
example: 26 example: 169
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -391,8 +186,8 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
site_id: 26 service_id: 169
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -409,7 +204,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer aadb1h6f6kD4V8vePZgcE35' - 'Bearer b3DckZ8g6ha6aPe4f5V1vdE'
controller: null controller: null
method: null method: null
route: null route: null
@ -417,14 +212,14 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/load-balancer' uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/stop'
metadata: metadata:
groupName: sites groupName: services
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
title: load-balancer title: stop
description: 'Update load balancer.' description: 'Stop service.'
authenticated: true authenticated: true
custom: [] custom: []
headers: headers:
@ -446,17 +241,17 @@ endpoints:
name: server_id name: server_id
description: 'The ID of the server.' description: 'The ID of the server.'
required: true required: true
example: 8 example: 29
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
site_id: service_id:
name: site_id name: service_id
description: 'The ID of the site.' description: 'The ID of the service.'
required: true required: true
example: 26 example: 169
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -464,43 +259,16 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
server_id: 8 server_id: 29
site_id: 26 service_id: 169
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters: []
method: cleanBodyParameters: []
name: method
description: 'Load balancer method, Required if the site type is Load balancer'
required: true
example: least-connections
type: string
enumValues:
- round-robin
- least-connections
- ip-hash
exampleWasSpecified: false
nullable: false
custom: []
servers:
name: servers
description: 'Array of servers including server, port, weight, backup. (server is the local IP of the server)'
required: true
example:
- deleniti
type: 'string[]'
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
method: least-connections
servers:
- deleniti
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 204
content: null content: null
headers: [] headers: []
description: '' description: ''
@ -509,7 +277,299 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 5E6hZa64bka1cV3Pdvf8Deg' - 'Bearer 1e8aZbfvE5643DacgkPhdV6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/restart'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: restart
description: 'Restart service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer c46baVZEg5dv1Pfe8Dha6k3'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/enable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: enable
description: 'Enable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer EvcehkDbdV43f61P86Za5ga'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/disable'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: disable
description: 'Disable service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer k8E5gf6d4h31bevaa6cVPZD'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}'
metadata:
groupName: services
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: 'Delete service.'
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
server_id:
name: server_id
description: 'The ID of the server.'
required: true
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
service_id:
name: service_id
description: 'The ID of the service.'
required: true
example: 169
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
server_id: 29
service_id: 169
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer Pekav16cd5ag486ZfD3EVbh'
controller: null controller: null
method: null method: null
route: null route: null

File diff suppressed because it is too large Load Diff

View File

@ -1,12 +1,12 @@
name: storage-providers name: source-controls
description: '' description: ''
endpoints: endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/storage-providers' uri: 'api/projects/{project_id}/source-controls'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -39,7 +39,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"data":[{"id":5,"project_id":null,"global":true,"name":"dolorem","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":6,"project_id":null,"global":true,"name":"itaque","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}' content: '{"data":[{"id":5,"project_id":null,"global":true,"name":"Zella Robel","provider":"github","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"},{"id":6,"project_id":null,"global":true,"name":"Jairo Williamson","provider":"github","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -47,7 +47,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer D16Vg58E6Pfkh3Zveab4dca' - 'Bearer e3f4ag8hkb5vZcDadPEV661'
controller: null controller: null
method: null method: null
route: null route: null
@ -55,9 +55,9 @@ endpoints:
- -
httpMethods: httpMethods:
- POST - POST
uri: 'api/projects/{project_id}/storage-providers' uri: 'api/projects/{project_id}/source-controls'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -87,11 +87,14 @@ endpoints:
bodyParameters: bodyParameters:
provider: provider:
name: provider name: provider
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)' description: 'The provider'
required: true required: true
example: alias example: gitlab
type: string type: string
enumValues: [] enumValues:
- gitlab
- github
- bitbucket
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
@ -99,7 +102,7 @@ endpoints:
name: name name: name
description: 'The name of the storage provider.' description: 'The name of the storage provider.'
required: true required: true
example: explicabo example: molestias
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -109,43 +112,54 @@ endpoints:
name: token name: token
description: 'The token if provider requires api token' description: 'The token if provider requires api token'
required: true required: true
example: ut example: in
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
key: url:
name: key name: url
description: 'The key if provider requires key' description: 'The URL if the provider is Gitlab and it is self-hosted'
required: true required: true
example: libero example: 'https://www.white.com/aperiam-dolor-nemo-qui-rerum-quod-quas'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
secret: username:
name: secret name: username
description: 'The secret if provider requires key' description: 'The username if the provider is Bitbucket'
required: true required: true
example: consequatur example: consectetur
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
password:
name: password
description: 'The password if the provider is Bitbucket'
required: true
example: 'y*P4_]ZdjE_:'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
provider: alias provider: gitlab
name: explicabo name: molestias
token: ut token: in
key: libero url: 'https://www.white.com/aperiam-dolor-nemo-qui-rerum-quod-quas'
secret: consequatur username: consectetur
password: 'y*P4_]ZdjE_:'
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":5,"project_id":null,"global":true,"name":"quos","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":5,"project_id":null,"global":true,"name":"Miss Claudine Goyette","provider":"github","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -153,7 +167,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer DaZ6d6Eck1bhVe3g4aP85vf' - 'Bearer DfegP56vkEa364Zbhda8V1c'
controller: null controller: null
method: null method: null
route: null route: null
@ -161,9 +175,9 @@ endpoints:
- -
httpMethods: httpMethods:
- GET - GET
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}' uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -186,11 +200,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
storageProvider_id: sourceControl_id:
name: storageProvider_id name: sourceControl_id
description: 'The ID of the storageProvider.' description: 'The ID of the sourceControl.'
required: true required: true
example: 3 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -198,7 +212,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
storageProvider_id: 3 sourceControl_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -207,7 +221,7 @@ endpoints:
responses: responses:
- -
status: 200 status: 200
content: '{"id":5,"project_id":null,"global":true,"name":"id","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"id":5,"project_id":null,"global":true,"name":"Mona Stark","provider":"github","created_at":"2025-04-05T17:48:03.000000Z","updated_at":"2025-04-05T17:48:03.000000Z"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -215,7 +229,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 1dekD4gva56bc683VPEhZfa' - 'Bearer ePc6fb65vh1Z4aakE3Dgd8V'
controller: null controller: null
method: null method: null
route: null route: null
@ -223,9 +237,9 @@ endpoints:
- -
httpMethods: httpMethods:
- PUT - PUT
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}' uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -248,11 +262,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
storageProvider_id: sourceControl_id:
name: storageProvider_id name: sourceControl_id
description: 'The ID of the storageProvider.' description: 'The ID of the sourceControl.'
required: true required: true
example: 3 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -260,7 +274,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
storageProvider_id: 3 sourceControl_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: bodyParameters:
@ -268,7 +282,47 @@ endpoints:
name: name name: name
description: 'The name of the storage provider.' description: 'The name of the storage provider.'
required: true required: true
example: sequi example: non
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
token:
name: token
description: 'The token if provider requires api token'
required: true
example: sunt
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
url:
name: url
description: 'The URL if the provider is Gitlab and it is self-hosted'
required: true
example: 'https://www.frami.org/ex-at-minus-rerum-quo-minus-ea'
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
username:
name: username
description: 'The username if the provider is Bitbucket'
required: true
example: natus
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
password:
name: password
description: 'The password if the provider is Bitbucket'
required: true
example: 'A^">*m{p]DI'
type: string type: string
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -278,7 +332,7 @@ endpoints:
name: global name: global
description: 'Accessible in all projects' description: 'Accessible in all projects'
required: true required: true
example: false example: true
type: string type: string
enumValues: enumValues:
- true - true
@ -287,13 +341,17 @@ endpoints:
nullable: false nullable: false
custom: [] custom: []
cleanBodyParameters: cleanBodyParameters:
name: sequi name: non
global: false token: sunt
url: 'https://www.frami.org/ex-at-minus-rerum-quo-minus-ea'
username: natus
password: 'A^">*m{p]DI'
global: true
fileParameters: [] fileParameters: []
responses: responses:
- -
status: 200 status: 200
content: '{"id":5,"project_id":null,"global":true,"name":"velit","provider":"s3","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}' content: '{"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"}'
headers: [] headers: []
description: '' description: ''
custom: [] custom: []
@ -301,7 +359,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer V65g18Pca4v3hDEkbZfe6da' - 'Bearer v3f6aaPk61Ze8hVdDbE5g4c'
controller: null controller: null
method: null method: null
route: null route: null
@ -309,9 +367,9 @@ endpoints:
- -
httpMethods: httpMethods:
- DELETE - DELETE
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}' uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
metadata: metadata:
groupName: storage-providers groupName: source-controls
groupDescription: '' groupDescription: ''
subgroup: '' subgroup: ''
subgroupDescription: '' subgroupDescription: ''
@ -334,11 +392,11 @@ endpoints:
exampleWasSpecified: false exampleWasSpecified: false
nullable: false nullable: false
custom: [] custom: []
storageProvider_id: sourceControl_id:
name: storageProvider_id name: sourceControl_id
description: 'The ID of the storageProvider.' description: 'The ID of the sourceControl.'
required: true required: true
example: 3 example: 1
type: integer type: integer
enumValues: [] enumValues: []
exampleWasSpecified: false exampleWasSpecified: false
@ -346,7 +404,7 @@ endpoints:
custom: [] custom: []
cleanUrlParameters: cleanUrlParameters:
project_id: 1 project_id: 1
storageProvider_id: 3 sourceControl_id: 1
queryParameters: [] queryParameters: []
cleanQueryParameters: [] cleanQueryParameters: []
bodyParameters: [] bodyParameters: []
@ -363,7 +421,7 @@ endpoints:
auth: auth:
- headers - headers
- Authorization - Authorization
- 'Bearer 1v6a6efgch3DbZ4aVE5d8kP' - 'Bearer fgk61vD68E4cZhP3bV5adea'
controller: null controller: null
method: null method: null
route: null route: null

370
.scribe/endpoints/13.yaml Normal file
View File

@ -0,0 +1,370 @@
name: storage-providers
description: ''
endpoints:
-
httpMethods:
- GET
uri: 'api/projects/{project_id}/storage-providers'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: list
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer fgh4eV31dP58kvaDEaZbc66'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: 'api/projects/{project_id}/storage-providers'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: create
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
queryParameters: []
cleanQueryParameters: []
bodyParameters:
provider:
name: provider
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)'
required: true
example: ab
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
name:
name: name
description: 'The name of the storage provider.'
required: true
example: quo
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
token:
name: token
description: 'The token if provider requires api token'
required: true
example: in
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
key:
name: key
description: 'The key if provider requires key'
required: true
example: sunt
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
secret:
name: secret
description: 'The secret if provider requires key'
required: true
example: molestias
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
provider: ab
name: quo
token: in
key: sunt
secret: molestias
fileParameters: []
responses:
-
status: 200
content: '{"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"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer e584613dkZaPDEVvgcahbf6'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- GET
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: show
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
storageProvider_id:
name: storageProvider_id
description: 'The ID of the storageProvider.'
required: true
example: 3
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
storageProvider_id: 3
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 200
content: '{"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"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer h6Zk6834dDce5fbPa1VvagE'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- PUT
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: update
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
storageProvider_id:
name: storageProvider_id
description: 'The ID of the storageProvider.'
required: true
example: 3
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
storageProvider_id: 3
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: 'The name of the storage provider.'
required: true
example: voluptas
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
global:
name: global
description: 'Accessible in all projects'
required: true
example: true
type: string
enumValues:
- true
- false
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: voluptas
global: true
fileParameters: []
responses:
-
status: 200
content: '{"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"}'
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer ak6fgd1Eba48chvPV3e5Z6D'
controller: null
method: null
route: null
custom: []
-
httpMethods:
- DELETE
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
metadata:
groupName: storage-providers
groupDescription: ''
subgroup: ''
subgroupDescription: ''
title: delete
description: ''
authenticated: true
custom: []
headers:
Authorization: 'Bearer YOUR-API-KEY'
Content-Type: application/json
Accept: application/json
urlParameters:
project_id:
name: project_id
description: 'The ID of the project.'
required: true
example: 1
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
storageProvider_id:
name: storageProvider_id
description: 'The ID of the storageProvider.'
required: true
example: 3
type: integer
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanUrlParameters:
project_id: 1
storageProvider_id: 3
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses:
-
status: 204
content: null
headers: []
description: ''
custom: []
responseFields: []
auth:
- headers
- Authorization
- 'Bearer PcaDbh6ZE4aV1e8fdv56k3g'
controller: null
method: null
route: null
custom: []

View File

@ -10,6 +10,9 @@
class CreateCronJob class CreateCronJob
{ {
/**
* @param array<string, mixed> $input
*/
public function create(Server $server, array $input): CronJob public function create(Server $server, array $input): CronJob
{ {
$cronJob = new CronJob([ $cronJob = new CronJob([
@ -28,6 +31,10 @@ public function create(Server $server, array $input): CronJob
return $cronJob; return $cronJob;
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<mixed>>
*/
public static function rules(array $input, Server $server): array public static function rules(array $input, Server $server): array
{ {
$rules = [ $rules = [

View File

@ -5,20 +5,30 @@
use App\Enums\DatabaseStatus; use App\Enums\DatabaseStatus;
use App\Models\Database; use App\Models\Database;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use Illuminate\Validation\Rule; use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
class CreateDatabase class CreateDatabase
{ {
/**
* @param array<string, mixed> $input
*/
public function create(Server $server, array $input): Database public function create(Server $server, array $input): Database
{ {
$database = new Database([ $database = new Database([
'server_id' => $server->id, 'server_id' => $server->id,
'charset' => $input['charset'],
'collation' => $input['collation'],
'name' => $input['name'], 'name' => $input['name'],
]); ]);
/** @var Service $service */
$service = $server->database();
/** @var \App\SSH\Services\Database\Database $databaseHandler */ /** @var \App\SSH\Services\Database\Database $databaseHandler */
$databaseHandler = $server->database()->handler(); $databaseHandler = $service->handler();
$databaseHandler->create($database->name); $databaseHandler->create($database->name, $database->charset, $database->collation);
$database->status = DatabaseStatus::READY; $database->status = DatabaseStatus::READY;
$database->save(); $database->save();
@ -32,6 +42,9 @@ public function create(Server $server, array $input): Database
} }
/** /**
* @param array<string, mixed> $input
* @return array<string, mixed>
*
* @throws ValidationException * @throws ValidationException
*/ */
public static function rules(Server $server, array $input): array public static function rules(Server $server, array $input): array
@ -40,7 +53,15 @@ public static function rules(Server $server, array $input): array
'name' => [ 'name' => [
'required', 'required',
'alpha_dash', 'alpha_dash',
Rule::unique('databases', 'name')->where('server_id', $server->id), Rule::unique('databases', 'name')->where('server_id', $server->id)->whereNull('deleted_at'),
],
'charset' => [
'required',
'string',
],
'collation' => [
'required',
'string',
], ],
]; ];
if (isset($input['user']) && $input['user']) { if (isset($input['user']) && $input['user']) {

View File

@ -5,6 +5,7 @@
use App\Enums\DatabaseUserStatus; use App\Enums\DatabaseUserStatus;
use App\Models\DatabaseUser; use App\Models\DatabaseUser;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\Database\Database; use App\SSH\Services\Database\Database;
use Illuminate\Validation\Rule; use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
@ -12,6 +13,9 @@
class CreateDatabaseUser class CreateDatabaseUser
{ {
/** /**
* @param array<string, mixed> $input
* @param array<string> $links
*
* @throws ValidationException * @throws ValidationException
*/ */
public function create(Server $server, array $input, array $links = []): DatabaseUser public function create(Server $server, array $input, array $links = []): DatabaseUser
@ -23,8 +27,12 @@ public function create(Server $server, array $input, array $links = []): Databas
'host' => (isset($input['remote']) && $input['remote']) || isset($input['host']) ? $input['host'] : 'localhost', 'host' => (isset($input['remote']) && $input['remote']) || isset($input['host']) ? $input['host'] : 'localhost',
'databases' => $links, 'databases' => $links,
]); ]);
/** @var Service $service */
$service = $server->database();
/** @var Database $databaseHandler */ /** @var Database $databaseHandler */
$databaseHandler = $server->database()->handler(); $databaseHandler = $service->handler();
$databaseHandler->createUser( $databaseHandler->createUser(
$databaseUser->username, $databaseUser->username,
$databaseUser->password, $databaseUser->password,
@ -41,6 +49,9 @@ public function create(Server $server, array $input, array $links = []): Databas
} }
/** /**
* @param array<string, mixed> $input
* @return array<string, mixed>
*
* @throws ValidationException * @throws ValidationException
*/ */
public static function rules(Server $server, array $input): array public static function rules(Server $server, array $input): array

View File

@ -2,14 +2,24 @@
namespace App\Actions\Database; namespace App\Actions\Database;
use App\Models\Backup;
use App\Models\Database; use App\Models\Database;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
class DeleteDatabase class DeleteDatabase
{ {
public function delete(Server $server, Database $database): void public function delete(Server $server, Database $database): void
{ {
$server->database()->handler()->delete($database->name); /** @var Service $service */
$service = $server->database();
/** @var \App\SSH\Services\Database\Database $handler */
$handler = $service->handler();
$handler->delete($database->name);
$database->delete(); $database->delete();
$database->backups()->each(function (Backup $backup): void {
app(ManageBackup::class)->stop($backup);
});
} }
} }

View File

@ -4,12 +4,18 @@
use App\Models\DatabaseUser; use App\Models\DatabaseUser;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\Database\Database;
class DeleteDatabaseUser class DeleteDatabaseUser
{ {
public function delete(Server $server, DatabaseUser $databaseUser): void public function delete(Server $server, DatabaseUser $databaseUser): void
{ {
$server->database()->handler()->deleteUser($databaseUser->username, $databaseUser->host); /** @var Service $service */
$service = $server->database();
/** @var Database $handler */
$handler = $service->handler();
$handler->deleteUser($databaseUser->username, $databaseUser->host);
$databaseUser->delete(); $databaseUser->delete();
} }
} }

View File

@ -5,12 +5,16 @@
use App\Models\Database; use App\Models\Database;
use App\Models\DatabaseUser; use App\Models\DatabaseUser;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use Illuminate\Validation\Rule; use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
class LinkUser class LinkUser
{ {
/** /**
* @param array<string, mixed> $input
* @return DatabaseUser $databaseUser
*
* @throws ValidationException * @throws ValidationException
*/ */
public function link(DatabaseUser $databaseUser, array $input): DatabaseUser public function link(DatabaseUser $databaseUser, array $input): DatabaseUser
@ -29,14 +33,20 @@ public function link(DatabaseUser $databaseUser, array $input): DatabaseUser
$databaseUser->databases = $input['databases']; $databaseUser->databases = $input['databases'];
/** @var Service $service */
$service = $databaseUser->server->database();
/** @var \App\SSH\Services\Database\Database $handler */
$handler = $service->handler();
// Unlink the user from all databases // Unlink the user from all databases
$databaseUser->server->database()->handler()->unlink( $handler->unlink(
$databaseUser->username, $databaseUser->username,
$databaseUser->host $databaseUser->host
); );
// Link the user to the selected databases // Link the user to the selected databases
$databaseUser->server->database()->handler()->link( $handler->link(
$databaseUser->username, $databaseUser->username,
$databaseUser->host, $databaseUser->host,
$databaseUser->databases $databaseUser->databases
@ -49,6 +59,10 @@ public function link(DatabaseUser $databaseUser, array $input): DatabaseUser
return $databaseUser; return $databaseUser;
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(Server $server, array $input): array public static function rules(Server $server, array $input): array
{ {
return [ return [

View File

@ -14,6 +14,8 @@
class ManageBackup class ManageBackup
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws AuthorizationException * @throws AuthorizationException
* @throws ValidationException * @throws ValidationException
*/ */
@ -35,6 +37,9 @@ public function create(Server $server, array $input): Backup
return $backup; return $backup;
} }
/**
* @param array<string, mixed> $input
*/
public function update(Backup $backup, array $input): void public function update(Backup $backup, array $input): void
{ {
$backup->interval = $input['interval'] == 'custom' ? $input['custom_interval'] : $input['interval']; $backup->interval = $input['interval'] == 'custom' ? $input['custom_interval'] : $input['interval'];
@ -47,7 +52,7 @@ public function delete(Backup $backup): void
$backup->status = BackupStatus::DELETING; $backup->status = BackupStatus::DELETING;
$backup->save(); $backup->save();
dispatch(function () use ($backup) { dispatch(function () use ($backup): void {
$files = $backup->files; $files = $backup->files;
foreach ($files as $file) { foreach ($files as $file) {
$file->status = BackupFileStatus::DELETING; $file->status = BackupFileStatus::DELETING;
@ -60,6 +65,10 @@ public function delete(Backup $backup): void
}); });
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(Server $server, array $input): array public static function rules(Server $server, array $input): array
{ {
$rules = [ $rules = [
@ -91,4 +100,10 @@ public static function rules(Server $server, array $input): array
return $rules; return $rules;
} }
public function stop(Backup $backup): void
{
$backup->status = BackupStatus::STOPPED;
$backup->save();
}
} }

View File

@ -28,7 +28,7 @@ public function delete(BackupFile $file): void
$file->status = BackupFileStatus::DELETING; $file->status = BackupFileStatus::DELETING;
$file->save(); $file->save();
dispatch(function () use ($file) { dispatch(function () use ($file): void {
$file->deleteFile(); $file->deleteFile();
}); });
} }

View File

@ -5,9 +5,13 @@
use App\Enums\BackupFileStatus; use App\Enums\BackupFileStatus;
use App\Models\BackupFile; use App\Models\BackupFile;
use App\Models\Database; use App\Models\Database;
use App\Models\Service;
class RestoreBackup class RestoreBackup
{ {
/**
* @param array<string, mixed> $input
*/
public function restore(BackupFile $backupFile, array $input): void public function restore(BackupFile $backupFile, array $input): void
{ {
/** @var Database $database */ /** @var Database $database */
@ -16,19 +20,24 @@ public function restore(BackupFile $backupFile, array $input): void
$backupFile->restored_to = $database->name; $backupFile->restored_to = $database->name;
$backupFile->save(); $backupFile->save();
dispatch(function () use ($backupFile, $database) { dispatch(function () use ($backupFile, $database): void {
/** @var Service $service */
$service = $database->server->database();
/** @var \App\SSH\Services\Database\Database $databaseHandler */ /** @var \App\SSH\Services\Database\Database $databaseHandler */
$databaseHandler = $database->server->database()->handler(); $databaseHandler = $service->handler();
$databaseHandler->restoreBackup($backupFile, $database->name); $databaseHandler->restoreBackup($backupFile, $database->name);
$backupFile->status = BackupFileStatus::RESTORED; $backupFile->status = BackupFileStatus::RESTORED;
$backupFile->restored_at = now(); $backupFile->restored_at = now();
$backupFile->save(); $backupFile->save();
})->catch(function () use ($backupFile) { })->catch(function () use ($backupFile): void {
$backupFile->status = BackupFileStatus::RESTORE_FAILED; $backupFile->status = BackupFileStatus::RESTORE_FAILED;
$backupFile->save(); $backupFile->save();
})->onConnection('ssh'); })->onConnection('ssh');
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -6,6 +6,7 @@
use App\Enums\BackupStatus; use App\Enums\BackupStatus;
use App\Models\Backup; use App\Models\Backup;
use App\Models\BackupFile; use App\Models\BackupFile;
use App\Models\Service;
use App\SSH\Services\Database\Database; use App\SSH\Services\Database\Database;
use Illuminate\Support\Str; use Illuminate\Support\Str;
@ -20,9 +21,11 @@ public function run(Backup $backup): BackupFile
]); ]);
$file->save(); $file->save();
dispatch(function () use ($file, $backup) { dispatch(function () use ($file, $backup): void {
/** @var Service $service */
$service = $backup->server->database();
/** @var Database $databaseHandler */ /** @var Database $databaseHandler */
$databaseHandler = $file->backup->server->database()->handler(); $databaseHandler = $service->handler();
$databaseHandler->runBackup($file); $databaseHandler->runBackup($file);
$file->status = BackupFileStatus::CREATED; $file->status = BackupFileStatus::CREATED;
$file->save(); $file->save();
@ -31,7 +34,7 @@ public function run(Backup $backup): BackupFile
$backup->status = BackupStatus::RUNNING; $backup->status = BackupStatus::RUNNING;
$backup->save(); $backup->save();
} }
})->catch(function () use ($file, $backup) { })->catch(function () use ($file, $backup): void {
$backup->status = BackupStatus::FAILED; $backup->status = BackupStatus::FAILED;
$backup->save(); $backup->save();
$file->status = BackupFileStatus::FAILED; $file->status = BackupFileStatus::FAILED;

View File

@ -0,0 +1,50 @@
<?php
namespace App\Actions\Database;
use App\Enums\DatabaseUserStatus;
use App\Models\DatabaseUser;
use App\Models\Server;
use App\SSH\Services\Database\Database;
class SyncDatabaseUsers
{
public function sync(Server $server): void
{
$service = $server->database();
if (! $service instanceof \App\Models\Service) {
return;
}
/** @var Database $handler */
$handler = $service->handler();
$this->updateUsers($server, $handler);
}
private function updateUsers(Server $server, Database $handler): void
{
$users = $handler->getUsers();
foreach ($users as $user) {
$databases = $user[2] != 'NULL' ? explode(',', $user[2]) : [];
/** @var ?DatabaseUser $databaseUser */
$databaseUser = $server->databaseUsers()
->where('username', $user[0])
->first();
if ($databaseUser === null) {
$server->databaseUsers()->create([
'username' => $user[0],
'host' => $user[1],
'databases' => $databases,
'status' => DatabaseUserStatus::READY,
]);
continue;
}
$databaseUser->databases = $databases;
$databaseUser->save();
}
}
}

View File

@ -0,0 +1,63 @@
<?php
namespace App\Actions\Database;
use App\Enums\DatabaseStatus;
use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\Database\Database;
class SyncDatabases
{
public function sync(Server $server): void
{
$service = $server->database();
if (! $service instanceof \App\Models\Service) {
return;
}
/** @var Database $handler */
$handler = $service->handler();
$this->updateCharsets($service, $handler);
$this->updateDatabases($server, $handler);
}
private function updateCharsets(Service $service, Database $handler): void
{
$data = $service->type_data ?? [];
$charsets = $handler->getCharsets();
$data['charsets'] = $charsets['charsets'] ?? [];
$data['defaultCharset'] = $charsets['defaultCharset'] ?? '';
$service->type_data = $data;
$service->save();
}
private function updateDatabases(Server $server, Database $handler): void
{
$databases = $handler->getDatabases();
foreach ($databases as $database) {
/** @var ?\App\Models\Database $db */
$db = $server->databases()
->where('name', $database[0])
->first();
if ($db === null) {
$server->databases()->create([
'name' => $database[0],
'collation' => $database[2],
'charset' => $database[1],
'status' => DatabaseStatus::READY,
]);
continue;
}
if ($db->collation !== $database[2] || $db->charset !== $database[1]) {
$db->update([
'collation' => $database[2],
'charset' => $database[1],
]);
}
}
}
}

View File

@ -11,6 +11,8 @@
class FetchFiles class FetchFiles
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws SSHError * @throws SSHError
*/ */
public function fetch(User $user, Server $server, array $input): void public function fetch(User $user, Server $server, array $input): void
@ -24,6 +26,9 @@ public function fetch(User $user, Server $server, array $input): void
); );
} }
/**
* @return array<string, array<string>>
*/
public static function rules(Server $server): array public static function rules(Server $server): array
{ {
return [ return [

View File

@ -5,10 +5,16 @@
use App\Enums\FirewallRuleStatus; use App\Enums\FirewallRuleStatus;
use App\Models\FirewallRule; use App\Models\FirewallRule;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\Firewall\Firewall; use App\SSH\Services\Firewall\Firewall;
use Exception;
class ManageRule class ManageRule
{ {
/**
* @param array<string, mixed> $input
* @return FirewallRule $rule
*/
public function create(Server $server, array $input): FirewallRule public function create(Server $server, array $input): FirewallRule
{ {
$sourceAny = $input['source_any'] ?? empty($input['source'] ?? null); $sourceAny = $input['source_any'] ?? empty($input['source'] ?? null);
@ -30,6 +36,10 @@ public function create(Server $server, array $input): FirewallRule
return $rule; return $rule;
} }
/**
* @param array<string, mixed> $input
* @return FirewallRule $rule
*/
public function update(FirewallRule $rule, array $input): FirewallRule public function update(FirewallRule $rule, array $input): FirewallRule
{ {
$sourceAny = $input['source_any'] ?? empty($input['source'] ?? null); $sourceAny = $input['source_any'] ?? empty($input['source'] ?? null);
@ -56,18 +66,20 @@ public function delete(FirewallRule $rule): void
dispatch(fn () => $this->applyRule($rule)); dispatch(fn () => $this->applyRule($rule));
} }
protected function applyRule($rule): void protected function applyRule(FirewallRule $rule): void
{ {
try { try {
/** @var Service $service */
$service = $rule->server->firewall();
/** @var Firewall $handler */ /** @var Firewall $handler */
$handler = $rule->server->firewall()->handler(); $handler = $service->handler();
$handler->applyRules(); $handler->applyRules();
} catch (\Exception $e) { } catch (Exception) {
$rule->server->firewallRules() $rule->server->firewallRules()
->where('status', '!=', FirewallRuleStatus::READY) ->where('status', '!=', FirewallRuleStatus::READY)
->update(['status' => FirewallRuleStatus::FAILED]); ->update(['status' => FirewallRuleStatus::FAILED]);
throw $e; return;
} }
if ($rule->status === FirewallRuleStatus::DELETING) { if ($rule->status === FirewallRuleStatus::DELETING) {
@ -80,6 +92,9 @@ protected function applyRule($rule): void
$rule->save(); $rule->save();
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -11,6 +11,10 @@
class GetMetrics class GetMetrics
{ {
/**
* @param array<string, mixed> $input
* @return Collection<int, mixed>
*/
public function filter(Server $server, array $input): Collection public function filter(Server $server, array $input): Collection
{ {
if (isset($input['from']) && isset($input['to']) && $input['from'] === $input['to']) { if (isset($input['from']) && isset($input['to']) && $input['from'] === $input['to']) {
@ -32,6 +36,9 @@ public function filter(Server $server, array $input): Collection
); );
} }
/**
* @return Collection<int, mixed>
*/
private function metrics( private function metrics(
Server $server, Server $server,
Carbon $fromDate, Carbon $fromDate,
@ -57,13 +64,16 @@ private function metrics(
->groupByRaw('date_interval') ->groupByRaw('date_interval')
->orderBy('date_interval') ->orderBy('date_interval')
->get() ->get()
->map(function ($item) { ->map(function ($item): \stdClass {
$item->date = Carbon::parse($item->date)->format('Y-m-d H:i'); $item->date = Carbon::parse($item->date)->format('Y-m-d H:i');
return $item; return $item;
}); });
} }
/**
* @param array<string, mixed> $input
*/
private function getFromDate(array $input): Carbon private function getFromDate(array $input): Carbon
{ {
if ($input['period'] === 'custom') { if ($input['period'] === 'custom') {
@ -73,6 +83,9 @@ private function getFromDate(array $input): Carbon
return Carbon::parse('-'.convert_time_format($input['period'])); return Carbon::parse('-'.convert_time_format($input['period']));
} }
/**
* @param array<string, mixed> $input
*/
private function getToDate(array $input): Carbon private function getToDate(array $input): Carbon
{ {
if ($input['period'] === 'custom') { if ($input['period'] === 'custom') {
@ -82,6 +95,9 @@ private function getToDate(array $input): Carbon
return Carbon::now(); return Carbon::now();
} }
/**
* @param array<string, mixed> $input
*/
private function getInterval(array $input): Expression private function getInterval(array $input): Expression
{ {
if ($input['period'] === 'custom') { if ($input['period'] === 'custom') {
@ -107,6 +123,10 @@ private function getInterval(array $input): Expression
return DB::raw("strftime('%Y-%m-%d 00:00:00', created_at) as date_interval"); return DB::raw("strftime('%Y-%m-%d 00:00:00', created_at) as date_interval");
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<string>>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
$rules = [ $rules = [

View File

@ -3,19 +3,29 @@
namespace App\Actions\Monitoring; namespace App\Actions\Monitoring;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\ServiceInterface;
class UpdateMetricSettings class UpdateMetricSettings
{ {
/**
* @param array<string, mixed> $input
*/
public function update(Server $server, array $input): void public function update(Server $server, array $input): void
{ {
/** @var Service $service */
$service = $server->monitoring(); $service = $server->monitoring();
/** @var ServiceInterface $handler */
$data = $service->handler()->data(); $handler = $service->handler();
$data = $handler->data();
$data['data_retention'] = $input['data_retention']; $data['data_retention'] = $input['data_retention'];
$service->type_data = $data; $service->type_data = $data;
$service->save(); $service->save();
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -3,24 +3,38 @@
namespace App\Actions\NodeJS; namespace App\Actions\NodeJS;
use App\Enums\ServiceStatus; use App\Enums\ServiceStatus;
use App\Exceptions\SSHError;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\NodeJS\NodeJS; use App\SSH\Services\NodeJS\NodeJS;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
class ChangeDefaultCli class ChangeDefaultCli
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
* @throws SSHError
*/
public function change(Server $server, array $input): void public function change(Server $server, array $input): void
{ {
$this->validate($server, $input); $this->validate($server, $input);
/** @var Service $service */
$service = $server->nodejs($input['version']); $service = $server->nodejs($input['version']);
/** @var NodeJS $handler */ /** @var NodeJS $handler */
$handler = $service->handler(); $handler = $service->handler();
$handler->setDefaultCli(); $handler->setDefaultCli();
$server->defaultService('nodejs')->update(['is_default' => 0]); $server->defaultService('nodejs')?->update(['is_default' => 0]);
$service->update(['is_default' => 1]); $service->update(['is_default' => 1]);
$service->update(['status' => ServiceStatus::READY]); $service->update(['status' => ServiceStatus::READY]);
} }
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function validate(Server $server, array $input): void public function validate(Server $server, array $input): void
{ {
if (! isset($input['version']) || ! in_array($input['version'], $server->installedNodejsVersions())) { if (! isset($input['version']) || ! in_array($input['version'], $server->installedNodejsVersions())) {

View File

@ -10,6 +10,9 @@
class InstallNewNodeJsVersion class InstallNewNodeJsVersion
{ {
/**
* @param array<string, mixed> $input
*/
public function install(Server $server, array $input): void public function install(Server $server, array $input): void
{ {
$nodejs = new Service([ $nodejs = new Service([
@ -23,15 +26,18 @@ public function install(Server $server, array $input): void
]); ]);
$nodejs->save(); $nodejs->save();
dispatch(function () use ($nodejs) { dispatch(function () use ($nodejs): void {
$nodejs->handler()->install(); $nodejs->handler()->install();
$nodejs->status = ServiceStatus::READY; $nodejs->status = ServiceStatus::READY;
$nodejs->save(); $nodejs->save();
})->catch(function () use ($nodejs) { })->catch(function () use ($nodejs): void {
$nodejs->delete(); $nodejs->delete();
})->onConnection('ssh'); })->onConnection('ssh');
} }
/**
* @return array<string, array<string>>
*/
public static function rules(Server $server): array public static function rules(Server $server): array
{ {
return [ return [

View File

@ -10,6 +10,11 @@
class UninstallNodeJS class UninstallNodeJS
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function uninstall(Server $server, array $input): void public function uninstall(Server $server, array $input): void
{ {
$this->validate($server, $input); $this->validate($server, $input);
@ -19,16 +24,18 @@ public function uninstall(Server $server, array $input): void
$nodejs->status = ServiceStatus::UNINSTALLING; $nodejs->status = ServiceStatus::UNINSTALLING;
$nodejs->save(); $nodejs->save();
dispatch(function () use ($nodejs) { dispatch(function () use ($nodejs): void {
$nodejs->handler()->uninstall(); $nodejs->handler()->uninstall();
$nodejs->delete(); $nodejs->delete();
})->catch(function () use ($nodejs) { })->catch(function () use ($nodejs): void {
$nodejs->status = ServiceStatus::FAILED; $nodejs->status = ServiceStatus::FAILED;
$nodejs->save(); $nodejs->save();
})->onConnection('ssh'); })->onConnection('ssh');
} }
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
*/ */
private function validate(Server $server, array $input): void private function validate(Server $server, array $input): void

View File

@ -11,8 +11,9 @@
class AddChannel class AddChannel
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
* @throws Exception
*/ */
public function add(User $user, array $input): void public function add(User $user, array $input): void
{ {
@ -42,13 +43,19 @@ public function add(User $user, array $input): void
} catch (Exception $e) { } catch (Exception $e) {
$channel->delete(); $channel->delete();
throw $e; throw ValidationException::withMessages([
'provider' => $e->getMessage(),
]);
} }
$channel->connected = true; $channel->connected = true;
$channel->save(); $channel->save();
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
$rules = [ $rules = [
@ -59,9 +66,13 @@ public static function rules(array $input): array
'label' => 'required', 'label' => 'required',
]; ];
return array_merge($rules, static::providerRules($input)); return array_merge($rules, self::providerRules($input));
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<string>>
*/
private static function providerRules(array $input): array private static function providerRules(array $input): array
{ {
if (! isset($input['provider'])) { if (! isset($input['provider'])) {

View File

@ -7,6 +7,9 @@
class EditChannel class EditChannel
{ {
/**
* @param array<string, mixed> $input
*/
public function edit(NotificationChannel $notificationChannel, User $user, array $input): void public function edit(NotificationChannel $notificationChannel, User $user, array $input): void
{ {
$notificationChannel->fill([ $notificationChannel->fill([
@ -16,6 +19,10 @@ public function edit(NotificationChannel $notificationChannel, User $user, array
$notificationChannel->save(); $notificationChannel->save();
} }
/**
* @param array<string, mixed> $input
* @return array<string, string>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
return [ return [

View File

@ -3,24 +3,37 @@
namespace App\Actions\PHP; namespace App\Actions\PHP;
use App\Enums\ServiceStatus; use App\Enums\ServiceStatus;
use App\Exceptions\SSHError;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\PHP\PHP; use App\SSH\Services\PHP\PHP;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
class ChangeDefaultCli class ChangeDefaultCli
{ {
/**
* @param array<string, mixed> $input
*
* @throws SSHError
*/
public function change(Server $server, array $input): void public function change(Server $server, array $input): void
{ {
$this->validate($server, $input); $this->validate($server, $input);
/** @var Service $service */
$service = $server->php($input['version']); $service = $server->php($input['version']);
/** @var PHP $handler */ /** @var PHP $handler */
$handler = $service->handler(); $handler = $service->handler();
$handler->setDefaultCli(); $handler->setDefaultCli();
$server->defaultService('php')->update(['is_default' => 0]); $server->defaultService('php')?->update(['is_default' => 0]);
$service->update(['is_default' => 1]); $service->update(['is_default' => 1]);
$service->update(['status' => ServiceStatus::READY]); $service->update(['status' => ServiceStatus::READY]);
} }
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function validate(Server $server, array $input): void public function validate(Server $server, array $input): void
{ {
if (! isset($input['version']) || ! in_array($input['version'], $server->installedPHPVersions())) { if (! isset($input['version']) || ! in_array($input['version'], $server->installedPHPVersions())) {

View File

@ -4,17 +4,25 @@
use App\Enums\PHPIniType; use App\Enums\PHPIniType;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use App\SSH\Services\PHP\PHP; use App\SSH\Services\PHP\PHP;
use Illuminate\Support\Facades\Validator; use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule; use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
use Throwable;
class GetPHPIni class GetPHPIni
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function getIni(Server $server, array $input): string public function getIni(Server $server, array $input): string
{ {
$this->validate($server, $input); $this->validate($server, $input);
/** @var Service $php */
$php = $server->php($input['version']); $php = $server->php($input['version']);
try { try {
@ -22,13 +30,18 @@ public function getIni(Server $server, array $input): string
$handler = $php->handler(); $handler = $php->handler();
return $handler->getPHPIni($input['type']); return $handler->getPHPIni($input['type']);
} catch (\Throwable $e) { } catch (Throwable $e) {
throw ValidationException::withMessages( throw ValidationException::withMessages(
['ini' => $e->getMessage()] ['ini' => $e->getMessage()]
); );
} }
} }
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function validate(Server $server, array $input): void public function validate(Server $server, array $input): void
{ {
Validator::make($input, [ Validator::make($input, [

View File

@ -10,6 +10,9 @@
class InstallNewPHP class InstallNewPHP
{ {
/**
* @param array<string, mixed> $input
*/
public function install(Server $server, array $input): void public function install(Server $server, array $input): void
{ {
$php = new Service([ $php = new Service([
@ -26,15 +29,18 @@ public function install(Server $server, array $input): void
]); ]);
$php->save(); $php->save();
dispatch(function () use ($php) { dispatch(function () use ($php): void {
$php->handler()->install(); $php->handler()->install();
$php->status = ServiceStatus::READY; $php->status = ServiceStatus::READY;
$php->save(); $php->save();
})->catch(function () use ($php) { })->catch(function () use ($php): void {
$php->delete(); $php->delete();
})->onConnection('ssh'); })->onConnection('ssh');
} }
/**
* @return array<string, array<string>>
*/
public static function rules(Server $server): array public static function rules(Server $server): array
{ {
return [ return [

View File

@ -2,7 +2,6 @@
namespace App\Actions\PHP; namespace App\Actions\PHP;
use App\Exceptions\SSHCommandError;
use App\Models\Server; use App\Models\Server;
use App\Models\Service; use App\Models\Service;
use App\SSH\Services\PHP\PHP; use App\SSH\Services\PHP\PHP;
@ -11,6 +10,11 @@
class InstallPHPExtension class InstallPHPExtension
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function install(Server $server, array $input): Service public function install(Server $server, array $input): Service
{ {
/** @var Service $service */ /** @var Service $service */
@ -23,20 +27,17 @@ public function install(Server $server, array $input): Service
} }
$typeData = $service->type_data; $typeData = $service->type_data;
$typeData['extensions'] = $typeData['extensions'] ?? []; $typeData['extensions'] ??= [];
$typeData['extensions'][] = $input['extension']; $typeData['extensions'][] = $input['extension'];
$service->type_data = $typeData; $service->type_data = $typeData;
$service->save(); $service->save();
dispatch( dispatch(
/** function () use ($service, $input): void {
* @throws SSHCommandError
*/
function () use ($service, $input) {
/** @var PHP $handler */ /** @var PHP $handler */
$handler = $service->handler(); $handler = $service->handler();
$handler->installExtension($input['extension']); $handler->installExtension($input['extension']);
})->catch(function () use ($service, $input) { })->catch(function () use ($service, $input): void {
$service->refresh(); $service->refresh();
$typeData = $service->type_data; $typeData = $service->type_data;
$typeData['extensions'] = array_values(array_diff($typeData['extensions'], [$input['extension']])); $typeData['extensions'] = array_values(array_diff($typeData['extensions'], [$input['extension']]));
@ -47,6 +48,9 @@ function () use ($service, $input) {
return $service; return $service;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(Server $server): array public static function rules(Server $server): array
{ {
return [ return [

View File

@ -10,6 +10,11 @@
class UninstallPHP class UninstallPHP
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function uninstall(Server $server, array $input): void public function uninstall(Server $server, array $input): void
{ {
$this->validate($server, $input); $this->validate($server, $input);
@ -19,16 +24,18 @@ public function uninstall(Server $server, array $input): void
$php->status = ServiceStatus::UNINSTALLING; $php->status = ServiceStatus::UNINSTALLING;
$php->save(); $php->save();
dispatch(function () use ($php) { dispatch(function () use ($php): void {
$php->handler()->uninstall(); $php->handler()->uninstall();
$php->delete(); $php->delete();
})->catch(function () use ($php) { })->catch(function () use ($php): void {
$php->status = ServiceStatus::FAILED; $php->status = ServiceStatus::FAILED;
$php->save(); $php->save();
})->onConnection('ssh'); })->onConnection('ssh');
} }
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
*/ */
private function validate(Server $server, array $input): void private function validate(Server $server, array $input): void

View File

@ -4,6 +4,7 @@
use App\Enums\PHPIniType; use App\Enums\PHPIniType;
use App\Models\Server; use App\Models\Server;
use App\Models\Service;
use Illuminate\Filesystem\FilesystemAdapter; use Illuminate\Filesystem\FilesystemAdapter;
use Illuminate\Support\Facades\Storage; use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str; use Illuminate\Support\Str;
@ -14,10 +15,13 @@
class UpdatePHPIni class UpdatePHPIni
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
*/ */
public function update(Server $server, array $input): void public function update(Server $server, array $input): void
{ {
/** @var Service $service */
$service = $server->php($input['version']); $service = $server->php($input['version']);
$tmpName = Str::random(10).strtotime('now'); $tmpName = Str::random(10).strtotime('now');
@ -48,6 +52,9 @@ private function deleteTempFile(string $name): void
} }
} }
/**
* @return array<string, array<string>>
*/
public static function rules(Server $server): array public static function rules(Server $server): array
{ {
return [ return [

View File

@ -9,6 +9,9 @@
class AddUser class AddUser
{ {
/**
* @param array<string, mixed> $input
*/
public function add(Project $project, array $input): void public function add(Project $project, array $input): void
{ {
/** @var User $user */ /** @var User $user */
@ -18,13 +21,16 @@ public function add(Project $project, array $input): void
$project->users()->attach($user); $project->users()->attach($user);
} }
/**
* @return array<string, array<string>>
*/
public static function rules(Project $project): array public static function rules(Project $project): array
{ {
return [ return [
'user' => [ 'user' => [
'required', 'required',
Rule::exists('users', 'id'), Rule::exists('users', 'id'),
Rule::unique('user_project', 'user_id')->where(function (Builder $query) use ($project) { Rule::unique('user_project', 'user_id')->where(function (Builder $query) use ($project): void {
$query->where('project_id', $project->id); $query->where('project_id', $project->id);
}), }),
], ],

View File

@ -8,10 +8,13 @@
class CreateProject class CreateProject
{ {
/**
* @param array<string, mixed> $input
*/
public function create(User $user, array $input): Project public function create(User $user, array $input): Project
{ {
if (isset($input['name'])) { if (isset($input['name'])) {
$input['name'] = strtolower($input['name']); $input['name'] = strtolower((string) $input['name']);
} }
$this->validate($input); $this->validate($input);
@ -27,6 +30,9 @@ public function create(User $user, array $input): Project
return $project; return $project;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [
@ -40,6 +46,9 @@ public static function rules(): array
]; ];
} }
/**
* @param array<string, mixed> $input
*/
private function validate(array $input): void private function validate(array $input): void
{ {
Validator::make($input, self::rules())->validate(); Validator::make($input, self::rules())->validate();

View File

@ -8,10 +8,13 @@
class UpdateProject class UpdateProject
{ {
/**
* @param array<string, mixed> $input
*/
public function update(Project $project, array $input): Project public function update(Project $project, array $input): Project
{ {
if (isset($input['name'])) { if (isset($input['name'])) {
$input['name'] = strtolower($input['name']); $input['name'] = strtolower((string) $input['name']);
} }
$this->validate($project, $input); $this->validate($project, $input);
@ -23,6 +26,9 @@ public function update(Project $project, array $input): Project
return $project; return $project;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(Project $project): array public static function rules(Project $project): array
{ {
return [ return [
@ -36,6 +42,9 @@ public static function rules(Project $project): array
]; ];
} }
/**
* @param array<string, mixed> $input
*/
private function validate(Project $project, array $input): void private function validate(Project $project, array $input): void
{ {
Validator::make($input, self::rules($project))->validate(); Validator::make($input, self::rules($project))->validate();

View File

@ -1,72 +0,0 @@
<?php
namespace App\Actions\Queue;
use App\Enums\QueueStatus;
use App\Models\Queue;
use App\Models\Server;
use App\Models\Site;
use App\SSH\Services\ProcessManager\ProcessManager;
use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException;
class CreateQueue
{
/**
* @throws ValidationException
*/
public function create(mixed $queueable, array $input): void
{
$queue = new Queue([
'server_id' => $queueable instanceof Server ? $queueable->id : $queueable->server_id,
'site_id' => $queueable instanceof Site ? $queueable->id : null,
'command' => $input['command'],
'user' => $input['user'],
'auto_start' => $input['auto_start'] ? 1 : 0,
'auto_restart' => $input['auto_restart'] ? 1 : 0,
'numprocs' => $input['numprocs'],
'status' => QueueStatus::CREATING,
]);
$queue->save();
dispatch(function () use ($queue) {
/** @var ProcessManager $processManager */
$processManager = $queue->server->processManager()->handler();
$processManager->create(
$queue->id,
$queue->command,
$queue->user,
$queue->auto_start,
$queue->auto_restart,
$queue->numprocs,
$queue->getLogFile(),
$queue->site_id
);
$queue->status = QueueStatus::RUNNING;
$queue->save();
})->catch(function () use ($queue) {
$queue->delete();
})->onConnection('ssh');
}
public static function rules(Site $site): array
{
return [
'command' => [
'required',
],
'user' => [
'required',
Rule::in([
'root',
$site->user,
]),
],
'numprocs' => [
'required',
'numeric',
'min:1',
],
];
}
}

View File

@ -1,13 +0,0 @@
<?php
namespace App\Actions\Queue;
use App\Models\Queue;
class DeleteQueue
{
public function delete(Queue $queue): void
{
$queue->delete();
}
}

View File

@ -1,72 +0,0 @@
<?php
namespace App\Actions\Queue;
use App\Enums\QueueStatus;
use App\Models\Queue;
use App\Models\Server;
use App\SSH\Services\ProcessManager\ProcessManager;
use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException;
class EditQueue
{
/**
* @throws ValidationException
*/
public function edit(Queue $queue, array $input): void
{
$queue->fill([
'command' => $input['command'],
'user' => $input['user'],
'auto_start' => $input['auto_start'] ? 1 : 0,
'auto_restart' => $input['auto_restart'] ? 1 : 0,
'numprocs' => $input['numprocs'],
'status' => QueueStatus::RESTARTING,
]);
$queue->save();
dispatch(function () use ($queue) {
/** @var ProcessManager $processManager */
$processManager = $queue->server->processManager()->handler();
$processManager->delete($queue->id, $queue->site_id);
$processManager->create(
$queue->id,
$queue->command,
$queue->user,
$queue->auto_start,
$queue->auto_restart,
$queue->numprocs,
$queue->getLogFile(),
$queue->site_id
);
$queue->status = QueueStatus::RUNNING;
$queue->save();
})->catch(function () use ($queue) {
$queue->status = QueueStatus::FAILED;
$queue->save();
})->onConnection('ssh');
}
public static function rules(Server $server): array
{
return [
'command' => [
'required',
],
'user' => [
'required',
Rule::in([
'root',
$server->ssh_user,
]),
],
'numprocs' => [
'required',
'numeric',
'min:1',
],
];
}
}

View File

@ -1,13 +0,0 @@
<?php
namespace App\Actions\Queue;
use App\Models\Queue;
class GetQueueLogs
{
public function getLogs(Queue $queue): string
{
return $queue->server->processManager()->handler()->getLogs($queue->user, $queue->getLogFile());
}
}

View File

@ -1,42 +0,0 @@
<?php
namespace App\Actions\Queue;
use App\Enums\QueueStatus;
use App\Models\Queue;
class ManageQueue
{
public function start(Queue $queue): void
{
$queue->status = QueueStatus::STARTING;
$queue->save();
dispatch(function () use ($queue) {
$queue->server->processManager()->handler()->start($queue->id, $queue->site_id);
$queue->status = QueueStatus::RUNNING;
$queue->save();
})->onConnection('ssh');
}
public function stop(Queue $queue): void
{
$queue->status = QueueStatus::STOPPING;
$queue->save();
dispatch(function () use ($queue) {
$queue->server->processManager()->handler()->stop($queue->id, $queue->site_id);
$queue->status = QueueStatus::STOPPED;
$queue->save();
})->onConnection('ssh');
}
public function restart(Queue $queue): void
{
$queue->status = QueueStatus::RESTARTING;
$queue->save();
dispatch(function () use ($queue) {
$queue->server->processManager()->handler()->restart($queue->id, $queue->site_id);
$queue->status = QueueStatus::RUNNING;
$queue->save();
})->onConnection('ssh');
}
}

View File

@ -0,0 +1,75 @@
<?php
namespace App\Actions\Redirect;
use App\Enums\RedirectStatus;
use App\Models\Redirect;
use App\Models\Service;
use App\Models\Site;
use App\SSH\Services\Webserver\Webserver;
use Illuminate\Validation\Rule;
class CreateRedirect
{
/**
* @param array<string, mixed> $input
*/
public function create(Site $site, array $input): Redirect
{
$redirect = new Redirect;
$redirect->site_id = $site->id;
$redirect->from = $input['from'];
$redirect->to = $input['to'];
$redirect->mode = $input['mode'];
$redirect->status = RedirectStatus::CREATING;
$redirect->save();
dispatch(function () use ($site, $redirect): void {
/** @var Service $service */
$service = $site->server->webserver();
/** @var Webserver $webserver */
$webserver = $service->handler();
$webserver->updateVHost($site);
$redirect->status = RedirectStatus::READY;
$redirect->save();
})
->catch(function () use ($redirect): void {
$redirect->status = RedirectStatus::FAILED;
$redirect->save();
})
->onConnection('ssh');
return $redirect->refresh();
}
/**
* @return array<string, array<string>>
*/
public static function rules(Site $site): array
{
return [
'from' => [
'required',
'string',
'max:255',
'not_regex:/^http(s)?:\/\//',
Rule::unique('redirects', 'from')->where('site_id', $site->id),
],
'to' => [
'required',
'url:http,https',
],
'mode' => [
'required',
'integer',
Rule::in([
301,
302,
307,
308,
]),
],
];
}
}

View File

@ -0,0 +1,30 @@
<?php
namespace App\Actions\Redirect;
use App\Enums\RedirectStatus;
use App\Models\Redirect;
use App\Models\Service;
use App\Models\Site;
use App\SSH\Services\Webserver\Webserver;
class DeleteRedirect
{
public function delete(Site $site, Redirect $redirect): void
{
$redirect->status = RedirectStatus::DELETING;
$redirect->save();
dispatch(function () use ($site, $redirect): void {
/** @var Service $service */
$service = $site->server->webserver();
/** @var Webserver $webserver */
$webserver = $service->handler();
$webserver->updateVHost($site);
$redirect->delete();
})->catch(function () use ($redirect): void {
$redirect->status = RedirectStatus::FAILED;
$redirect->save();
})->onConnection('ssh');
}
}

View File

@ -5,6 +5,7 @@
use App\Enums\SslStatus; use App\Enums\SslStatus;
use App\Enums\SslType; use App\Enums\SslType;
use App\Models\ServerLog; use App\Models\ServerLog;
use App\Models\Service;
use App\Models\Site; use App\Models\Site;
use App\Models\Ssl; use App\Models\Ssl;
use App\SSH\Services\Webserver\Webserver; use App\SSH\Services\Webserver\Webserver;
@ -14,6 +15,8 @@
class CreateSSL class CreateSSL
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
*/ */
public function create(Site $site, array $input): void public function create(Site $site, array $input): void
@ -40,19 +43,25 @@ public function create(Site $site, array $input): void
$ssl->log_id = ServerLog::log($site->server, 'create-ssl', '', $site)->id; $ssl->log_id = ServerLog::log($site->server, 'create-ssl', '', $site)->id;
$ssl->save(); $ssl->save();
dispatch(function () use ($site, $ssl) { dispatch(function () use ($site, $ssl): void {
/** @var Service $service */
$service = $site->server->webserver();
/** @var Webserver $webserver */ /** @var Webserver $webserver */
$webserver = $site->server->webserver()->handler(); $webserver = $service->handler();
$webserver->setupSSL($ssl); $webserver->setupSSL($ssl);
$ssl->status = SslStatus::CREATED; $ssl->status = SslStatus::CREATED;
$ssl->save(); $ssl->save();
$webserver->updateVHost($site); $webserver->updateVHost($site);
})->catch(function () use ($ssl) { })->catch(function () use ($ssl): void {
$ssl->status = SslStatus::FAILED; $ssl->status = SslStatus::FAILED;
$ssl->save(); $ssl->save();
})->onConnection('ssh'); })->onConnection('ssh');
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
$rules = [ $rules = [

View File

@ -3,6 +3,7 @@
namespace App\Actions\SSL; namespace App\Actions\SSL;
use App\Enums\SslStatus; use App\Enums\SslStatus;
use App\Models\Service;
use App\Models\Ssl; use App\Models\Ssl;
use App\SSH\Services\Webserver\Webserver; use App\SSH\Services\Webserver\Webserver;
@ -12,8 +13,10 @@ public function delete(Ssl $ssl): void
{ {
$ssl->status = SslStatus::DELETING; $ssl->status = SslStatus::DELETING;
$ssl->save(); $ssl->save();
/** @var Service $service */
$service = $ssl->site->server->webserver();
/** @var Webserver $webserver */ /** @var Webserver $webserver */
$webserver = $ssl->site->server->webserver()->handler(); $webserver = $service->handler();
$webserver->removeSSL($ssl); $webserver->removeSSL($ssl);
$ssl->delete(); $ssl->delete();
} }

View File

@ -7,6 +7,9 @@
class CreateScript class CreateScript
{ {
/**
* @param array<string, mixed> $input
*/
public function create(User $user, array $input): Script public function create(User $user, array $input): Script
{ {
$script = new Script([ $script = new Script([
@ -20,6 +23,9 @@ public function create(User $user, array $input): Script
return $script; return $script;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -7,6 +7,9 @@
class EditScript class EditScript
{ {
/**
* @param array<string, mixed> $input
*/
public function edit(Script $script, User $user, array $input): Script public function edit(Script $script, User $user, array $input): Script
{ {
$script->name = $input['name']; $script->name = $input['name'];
@ -18,6 +21,9 @@ public function edit(Script $script, User $user, array $input): Script
return $script; return $script;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -11,6 +11,9 @@
class ExecuteScript class ExecuteScript
{ {
/**
* @param array<string, mixed> $input
*/
public function execute(Script $script, array $input): ScriptExecution public function execute(Script $script, array $input): ScriptExecution
{ {
$execution = new ScriptExecution([ $execution = new ScriptExecution([
@ -22,16 +25,19 @@ public function execute(Script $script, array $input): ScriptExecution
]); ]);
$execution->save(); $execution->save();
dispatch(function () use ($execution, $script) { dispatch(function () use ($execution, $script): void {
/** @var Server $server */
$server = $execution->server;
$content = $execution->getContent(); $content = $execution->getContent();
$log = ServerLog::make($execution->server, 'script-'.$script->id.'-'.strtotime('now')); $log = ServerLog::newLog($server, 'script-'.$script->id.'-'.strtotime('now'));
$log->save(); $log->save();
$execution->server_log_id = $log->id; $execution->server_log_id = $log->id;
$execution->save(); $execution->save();
$execution->server->os()->runScript('~/', $content, $log, $execution->user); $server->os()->runScript('~/', $content, $log, $execution->user);
$execution->status = ScriptExecutionStatus::COMPLETED; $execution->status = ScriptExecutionStatus::COMPLETED;
$execution->save(); $execution->save();
})->catch(function () use ($execution) { })->catch(function () use ($execution): void {
$execution->status = ScriptExecutionStatus::FAILED; $execution->status = ScriptExecutionStatus::FAILED;
$execution->save(); $execution->save();
})->onConnection('ssh'); })->onConnection('ssh');
@ -39,12 +45,16 @@ public function execute(Script $script, array $input): ScriptExecution
return $execution; return $execution;
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
$users = ['root']; $users = ['root'];
if (isset($input['server'])) { if (isset($input['server'])) {
/** @var ?Server $server */ /** @var Server $server */
$server = Server::query()->find($input['server']); $server = Server::query()->findOrFail($input['server']);
$users = $server->getSshUsers(); $users = $server->getSshUsers();
} }

View File

@ -24,6 +24,9 @@
class CreateServer class CreateServer
{ {
/**
* @param array<string, mixed> $input
*/
public function create(User $creator, Project $project, array $input): Server public function create(User $creator, Project $project, array $input): Server
{ {
$server = new Server([ $server = new Server([
@ -81,7 +84,7 @@ public function create(User $creator, Project $project, array $input): Server
private function install(Server $server): void private function install(Server $server): void
{ {
dispatch(function () use ($server) { dispatch(function () use ($server): void {
$maxWait = 180; $maxWait = 180;
while ($maxWait > 0) { while ($maxWait > 0) {
sleep(10); sleep(10);
@ -102,7 +105,7 @@ private function install(Server $server): void
]); ]);
Notifier::send($server, new ServerInstallationSucceed($server)); Notifier::send($server, new ServerInstallationSucceed($server));
}) })
->catch(function (Throwable $e) use ($server) { ->catch(function (Throwable $e) use ($server): void {
$server->update([ $server->update([
'status' => ServerStatus::INSTALLATION_FAILED, 'status' => ServerStatus::INSTALLATION_FAILED,
]); ]);
@ -114,6 +117,10 @@ private function install(Server $server): void
->onConnection('ssh'); ->onConnection('ssh');
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(Project $project, array $input): array public static function rules(Project $project, array $input): array
{ {
$rules = [ $rules = [
@ -129,28 +136,22 @@ public static function rules(Project $project, array $input): array
Rule::in(config('core.operating_systems')), Rule::in(config('core.operating_systems')),
], ],
'server_provider' => [ 'server_provider' => [
Rule::when(function () use ($input) { Rule::when(fn (): bool => isset($input['provider']) && $input['provider'] != ServerProvider::CUSTOM, [
return isset($input['provider']) && $input['provider'] != ServerProvider::CUSTOM;
}, [
'required', 'required',
Rule::exists('server_providers', 'id')->where(function (Builder $query) use ($project) { Rule::exists('server_providers', 'id')->where(function (Builder $query) use ($project): void {
$query->where('project_id', $project->id) $query->where('project_id', $project->id)
->orWhereNull('project_id'); ->orWhereNull('project_id');
}), }),
]), ]),
], ],
'ip' => [ 'ip' => [
Rule::when(function () use ($input) { Rule::when(fn (): bool => isset($input['provider']) && $input['provider'] == ServerProvider::CUSTOM, [
return isset($input['provider']) && $input['provider'] == ServerProvider::CUSTOM;
}, [
'required', 'required',
new RestrictedIPAddressesRule, new RestrictedIPAddressesRule,
]), ]),
], ],
'port' => [ 'port' => [
Rule::when(function () use ($input) { Rule::when(fn (): bool => isset($input['provider']) && $input['provider'] == ServerProvider::CUSTOM, [
return isset($input['provider']) && $input['provider'] == ServerProvider::CUSTOM;
}, [
'required', 'required',
'numeric', 'numeric',
'min:1', 'min:1',
@ -162,6 +163,10 @@ public static function rules(Project $project, array $input): array
return array_merge($rules, self::typeRules($input), self::providerRules($input)); return array_merge($rules, self::typeRules($input), self::providerRules($input));
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<string>>
*/
private static function typeRules(array $input): array private static function typeRules(array $input): array
{ {
if (! isset($input['type']) || ! in_array($input['type'], config('core.server_types'))) { if (! isset($input['type']) || ! in_array($input['type'], config('core.server_types'))) {
@ -173,6 +178,10 @@ private static function typeRules(array $input): array
return $server->type()->createRules($input); return $server->type()->createRules($input);
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<string>>
*/
private static function providerRules(array $input): array private static function providerRules(array $input): array
{ {
if ( if (

View File

@ -8,6 +8,8 @@
class CreateServerLog class CreateServerLog
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
*/ */
public function create(Server $server, array $input): void public function create(Server $server, array $input): void
@ -20,6 +22,9 @@ public function create(Server $server, array $input): void
]); ]);
} }
/**
* @return array<string, string>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -10,6 +10,9 @@
class EditServer class EditServer
{ {
/** /**
* @param array<string, mixed> $input
* @return Server $server
*
* @throws ValidationException * @throws ValidationException
*/ */
public function edit(Server $server, array $input): Server public function edit(Server $server, array $input): Server
@ -42,6 +45,9 @@ public function edit(Server $server, array $input): Server
return $server; return $server;
} }
/**
* @return array<string, array<int, mixed>>
*/
public static function rules(Server $server): array public static function rules(Server $server): array
{ {
return [ return [

View File

@ -13,11 +13,11 @@ public function update(Server $server): void
{ {
$server->status = ServerStatus::UPDATING; $server->status = ServerStatus::UPDATING;
$server->save(); $server->save();
dispatch(function () use ($server) { dispatch(function () use ($server): void {
$server->os()->upgrade(); $server->os()->upgrade();
$server->checkConnection(); $server->checkConnection();
$server->checkForUpdates(); $server->checkForUpdates();
})->catch(function () use ($server) { })->catch(function () use ($server): void {
Notifier::send($server, new ServerUpdateFailed($server)); Notifier::send($server, new ServerUpdateFailed($server));
$server->checkConnection(); $server->checkConnection();
})->onConnection('ssh'); })->onConnection('ssh');

View File

@ -3,6 +3,7 @@
namespace App\Actions\ServerProvider; namespace App\Actions\ServerProvider;
use App\Models\Project; use App\Models\Project;
use App\Models\Server;
use App\Models\ServerProvider; use App\Models\ServerProvider;
use App\Models\User; use App\Models\User;
use App\ServerProviders\ServerProvider as ServerProviderContract; use App\ServerProviders\ServerProvider as ServerProviderContract;
@ -13,11 +14,13 @@
class CreateServerProvider class CreateServerProvider
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
*/ */
public function create(User $user, Project $project, array $input): ServerProvider public function create(User $user, Project $project, array $input): ServerProvider
{ {
$provider = static::getProvider($input['provider']); $provider = self::getProvider($input['provider']);
try { try {
$provider->connect($input); $provider->connect($input);
@ -40,13 +43,19 @@ public function create(User $user, Project $project, array $input): ServerProvid
return $serverProvider; return $serverProvider;
} }
private static function getProvider($name): ServerProviderContract private static function getProvider(string $name): ServerProviderContract
{ {
$providerClass = config('core.server_providers_class.'.$name); $providerClass = config('core.server_providers_class.'.$name);
/** @var ServerProviderContract $provider */
$provider = new $providerClass(new ServerProvider, new Server);
return new $providerClass; return $provider;
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
$rules = [ $rules = [
@ -60,15 +69,19 @@ public static function rules(array $input): array
], ],
]; ];
return array_merge($rules, static::providerRules($input)); return array_merge($rules, self::providerRules($input));
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<string>>
*/
private static function providerRules(array $input): array private static function providerRules(array $input): array
{ {
if (! isset($input['provider'])) { if (! isset($input['provider'])) {
return []; return [];
} }
return static::getProvider($input['provider'])->credentialValidationRules($input); return self::getProvider($input['provider'])->credentialValidationRules($input);
} }
} }

View File

@ -7,6 +7,9 @@
class EditServerProvider class EditServerProvider
{ {
/**
* @param array<string, mixed> $input
*/
public function edit(ServerProvider $serverProvider, Project $project, array $input): ServerProvider public function edit(ServerProvider $serverProvider, Project $project, array $input): ServerProvider
{ {
$serverProvider->profile = $input['name']; $serverProvider->profile = $input['name'];
@ -17,6 +20,9 @@ public function edit(ServerProvider $serverProvider, Project $project, array $in
return $serverProvider; return $serverProvider;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -10,6 +10,9 @@
class Install class Install
{ {
/**
* @param array<string, mixed> $input
*/
public function install(Server $server, array $input): Service public function install(Server $server, array $input): Service
{ {
$input['type'] = config('core.service_types')[$input['name']]; $input['type'] = config('core.service_types')[$input['name']];
@ -28,11 +31,11 @@ public function install(Server $server, array $input): Service
$service->save(); $service->save();
dispatch(function () use ($service) { dispatch(function () use ($service): void {
$service->handler()->install(); $service->handler()->install();
$service->status = ServiceStatus::READY; $service->status = ServiceStatus::READY;
$service->save(); $service->save();
})->catch(function () use ($service) { })->catch(function () use ($service): void {
$service->status = ServiceStatus::INSTALLATION_FAILED; $service->status = ServiceStatus::INSTALLATION_FAILED;
$service->save(); $service->save();
})->onConnection('ssh'); })->onConnection('ssh');
@ -40,6 +43,10 @@ public function install(Server $server, array $input): Service
return $service; return $service;
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<int, mixed>>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
$rules = [ $rules = [

View File

@ -11,7 +11,7 @@ public function start(Service $service): void
{ {
$service->status = ServiceStatus::STARTING; $service->status = ServiceStatus::STARTING;
$service->save(); $service->save();
dispatch(function () use ($service) { dispatch(function () use ($service): void {
$status = $service->server->systemd()->start($service->unit); $status = $service->server->systemd()->start($service->unit);
if (str($status)->contains('Active: active')) { if (str($status)->contains('Active: active')) {
$service->status = ServiceStatus::READY; $service->status = ServiceStatus::READY;
@ -26,7 +26,7 @@ public function stop(Service $service): void
{ {
$service->status = ServiceStatus::STOPPING; $service->status = ServiceStatus::STOPPING;
$service->save(); $service->save();
dispatch(function () use ($service) { dispatch(function () use ($service): void {
$status = $service->server->systemd()->stop($service->unit); $status = $service->server->systemd()->stop($service->unit);
if (str($status)->contains('Active: inactive')) { if (str($status)->contains('Active: inactive')) {
$service->status = ServiceStatus::STOPPED; $service->status = ServiceStatus::STOPPED;
@ -41,7 +41,7 @@ public function restart(Service $service): void
{ {
$service->status = ServiceStatus::RESTARTING; $service->status = ServiceStatus::RESTARTING;
$service->save(); $service->save();
dispatch(function () use ($service) { dispatch(function () use ($service): void {
$status = $service->server->systemd()->restart($service->unit); $status = $service->server->systemd()->restart($service->unit);
if (str($status)->contains('Active: active')) { if (str($status)->contains('Active: active')) {
$service->status = ServiceStatus::READY; $service->status = ServiceStatus::READY;
@ -56,7 +56,7 @@ public function enable(Service $service): void
{ {
$service->status = ServiceStatus::ENABLING; $service->status = ServiceStatus::ENABLING;
$service->save(); $service->save();
dispatch(function () use ($service) { dispatch(function () use ($service): void {
$status = $service->server->systemd()->enable($service->unit); $status = $service->server->systemd()->enable($service->unit);
if (str($status)->contains('Active: active')) { if (str($status)->contains('Active: active')) {
$service->status = ServiceStatus::READY; $service->status = ServiceStatus::READY;
@ -71,7 +71,7 @@ public function disable(Service $service): void
{ {
$service->status = ServiceStatus::DISABLING; $service->status = ServiceStatus::DISABLING;
$service->save(); $service->save();
dispatch(function () use ($service) { dispatch(function () use ($service): void {
$status = $service->server->systemd()->disable($service->unit); $status = $service->server->systemd()->disable($service->unit);
if (str($status)->contains('Active: inactive')) { if (str($status)->contains('Active: inactive')) {
$service->status = ServiceStatus::DISABLED; $service->status = ServiceStatus::DISABLED;

View File

@ -20,10 +20,10 @@ public function uninstall(Service $service): void
$service->status = ServiceStatus::UNINSTALLING; $service->status = ServiceStatus::UNINSTALLING;
$service->save(); $service->save();
dispatch(function () use ($service) { dispatch(function () use ($service): void {
$service->handler()->uninstall(); $service->handler()->uninstall();
$service->delete(); $service->delete();
})->catch(function () use ($service) { })->catch(function () use ($service): void {
$service->status = ServiceStatus::FAILED; $service->status = ServiceStatus::FAILED;
$service->save(); $service->save();
})->onConnection('ssh'); })->onConnection('ssh');

View File

@ -7,6 +7,9 @@
class CreateCommand class CreateCommand
{ {
/**
* @param array<string, mixed> $input
*/
public function create(Site $site, array $input): Command public function create(Site $site, array $input): Command
{ {
$script = new Command([ $script = new Command([
@ -19,6 +22,9 @@ public function create(Site $site, array $input): Command
return $script; return $script;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -19,6 +19,11 @@
class CreateSite class CreateSite
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function create(Server $server, array $input): Site public function create(Server $server, array $input): Site
{ {
DB::beginTransaction(); DB::beginTransaction();
@ -40,7 +45,7 @@ public function create(Server $server, array $input): Site
// check has access to repository // check has access to repository
try { try {
if ($site->sourceControl) { if ($site->sourceControl) {
$site->sourceControl?->getRepo($site->repository); $site->sourceControl->getRepo($site->repository);
} }
} catch (SourceControlIsNotConnected) { } catch (SourceControlIsNotConnected) {
throw ValidationException::withMessages([ throw ValidationException::withMessages([
@ -72,14 +77,14 @@ public function create(Server $server, array $input): Site
$site->commands()->createMany($site->type()->baseCommands()); $site->commands()->createMany($site->type()->baseCommands());
// install site // install site
dispatch(function () use ($site) { dispatch(function () use ($site): void {
$site->type()->install(); $site->type()->install();
$site->update([ $site->update([
'status' => SiteStatus::READY, 'status' => SiteStatus::READY,
'progress' => 100, 'progress' => 100,
]); ]);
Notifier::send($site, new SiteInstallationSucceed($site)); Notifier::send($site, new SiteInstallationSucceed($site));
})->catch(function () use ($site) { })->catch(function () use ($site): void {
$site->status = SiteStatus::INSTALLATION_FAILED; $site->status = SiteStatus::INSTALLATION_FAILED;
$site->save(); $site->save();
Notifier::send($site, new SiteInstallationFailed($site)); Notifier::send($site, new SiteInstallationFailed($site));
@ -96,6 +101,10 @@ public function create(Server $server, array $input): Site
} }
} }
/**
* @param array<string, mixed> $input
* @return array<string, mixed>
*/
public static function rules(Server $server, array $input): array public static function rules(Server $server, array $input): array
{ {
$rules = [ $rules = [
@ -106,9 +115,7 @@ public static function rules(Server $server, array $input): array
'domain' => [ 'domain' => [
'required', 'required',
new DomainRule, new DomainRule,
Rule::unique('sites', 'domain')->where(function ($query) use ($server) { Rule::unique('sites', 'domain')->where(fn ($query) => $query->where('server_id', $server->id)),
return $query->where('server_id', $server->id);
}),
], ],
'aliases.*' => [ 'aliases.*' => [
new DomainRule, new DomainRule,
@ -125,6 +132,10 @@ public static function rules(Server $server, array $input): array
return array_merge($rules, self::typeRules($server, $input)); return array_merge($rules, self::typeRules($server, $input));
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<string>>
*/
private static function typeRules(Server $server, array $input): array private static function typeRules(Server $server, array $input): array
{ {
if (! isset($input['type']) || ! in_array($input['type'], config('core.site_types'))) { if (! isset($input['type']) || ! in_array($input['type'], config('core.site_types'))) {

View File

@ -3,6 +3,7 @@
namespace App\Actions\Site; namespace App\Actions\Site;
use App\Exceptions\SSHError; use App\Exceptions\SSHError;
use App\Models\Service;
use App\Models\Site; use App\Models\Site;
use App\SSH\Services\PHP\PHP; use App\SSH\Services\PHP\PHP;
use App\SSH\Services\Webserver\Webserver; use App\SSH\Services\Webserver\Webserver;
@ -14,13 +15,18 @@ class DeleteSite
*/ */
public function delete(Site $site): void public function delete(Site $site): void
{ {
/** @var Service $service */
$service = $site->server->webserver();
/** @var Webserver $webserverHandler */ /** @var Webserver $webserverHandler */
$webserverHandler = $site->server->webserver()->handler(); $webserverHandler = $service->handler();
$webserverHandler->deleteSite($site); $webserverHandler->deleteSite($site);
if ($site->isIsolated()) { if ($site->isIsolated()) {
/** @var Service $phpService */
$phpService = $site->server->php();
/** @var PHP $php */ /** @var PHP $php */
$php = $site->server->php()->handler(); $php = $phpService->handler();
$php->removeFpmPool($site->user, $site->php_version, $site->id); $php->removeFpmPool($site->user, $site->php_version, $site->id);
$os = $site->server->os(); $os = $site->server->os();

View File

@ -39,9 +39,8 @@ public function run(Site $site): Deployment
} }
$deployment->save(); $deployment->save();
dispatch(function () use ($site, $deployment) { dispatch(function () use ($site, $deployment): void {
/** @var ServerLog $log */ $log = ServerLog::newLog($site->server, 'deploy-'.strtotime('now'))
$log = ServerLog::make($site->server, 'deploy-'.strtotime('now'))
->forSite($site); ->forSite($site);
$log->save(); $log->save();
$deployment->log_id = $log->id; $deployment->log_id = $log->id;
@ -56,7 +55,7 @@ public function run(Site $site): Deployment
$deployment->status = DeploymentStatus::FINISHED; $deployment->status = DeploymentStatus::FINISHED;
$deployment->save(); $deployment->save();
Notifier::send($site, new DeploymentCompleted($deployment, $site)); Notifier::send($site, new DeploymentCompleted($deployment, $site));
})->catch(function () use ($deployment, $site) { })->catch(function () use ($deployment, $site): void {
$deployment->status = DeploymentStatus::FAILED; $deployment->status = DeploymentStatus::FAILED;
$deployment->save(); $deployment->save();
Notifier::send($site, new DeploymentCompleted($deployment, $site)); Notifier::send($site, new DeploymentCompleted($deployment, $site));

View File

@ -6,6 +6,9 @@
class EditCommand class EditCommand
{ {
/**
* @param array<string, mixed> $input
*/
public function edit(Command $command, array $input): Command public function edit(Command $command, array $input): Command
{ {
$command->name = $input['name']; $command->name = $input['name'];
@ -15,6 +18,9 @@ public function edit(Command $command, array $input): Command
return $command; return $command;
} }
/**
* @return array<string, array<string>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -10,6 +10,9 @@
class ExecuteCommand class ExecuteCommand
{ {
/**
* @param array<string, mixed> $input
*/
public function execute(Command $command, User $user, array $input): CommandExecution public function execute(Command $command, User $user, array $input): CommandExecution
{ {
$execution = new CommandExecution([ $execution = new CommandExecution([
@ -21,22 +24,22 @@ public function execute(Command $command, User $user, array $input): CommandExec
]); ]);
$execution->save(); $execution->save();
dispatch(function () use ($execution, $command) { dispatch(function () use ($execution, $command): void {
$content = $execution->getContent(); $content = $execution->getContent();
$log = ServerLog::make($execution->server, 'command-'.$command->id.'-'.strtotime('now')); $log = ServerLog::newLog($execution->server, 'command-'.$command->id.'-'.strtotime('now'));
$log->save(); $log->save();
$execution->server_log_id = $log->id; $execution->server_log_id = $log->id;
$execution->save(); $execution->save();
$execution->server->os()->runScript( $execution->server->os()->runScript(
path: $command->site->path, path: $command->site->path,
script: $content, script: $content,
user: $command->site->user,
serverLog: $log, serverLog: $log,
user: $command->site->user,
variables: $execution->variables variables: $execution->variables
); );
$execution->status = CommandExecutionStatus::COMPLETED; $execution->status = CommandExecutionStatus::COMPLETED;
$execution->save(); $execution->save();
})->catch(function () use ($execution) { })->catch(function () use ($execution): void {
$execution->status = CommandExecutionStatus::FAILED; $execution->status = CommandExecutionStatus::FAILED;
$execution->save(); $execution->save();
})->onConnection('ssh'); })->onConnection('ssh');
@ -44,6 +47,10 @@ public function execute(Command $command, User $user, array $input): CommandExec
return $execution; return $execution;
} }
/**
* @param array<string, mixed> $input
* @return array<string, string|array<int, mixed>>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
return [ return [

View File

@ -2,23 +2,33 @@
namespace App\Actions\Site; namespace App\Actions\Site;
use App\Models\Service;
use App\Models\Site; use App\Models\Site;
use App\SSH\Services\Webserver\Webserver; use App\SSH\Services\Webserver\Webserver;
use App\ValidationRules\DomainRule; use App\ValidationRules\DomainRule;
class UpdateAliases class UpdateAliases
{ {
/**
* @param array<string, mixed> $input
*/
public function update(Site $site, array $input): void public function update(Site $site, array $input): void
{ {
$site->aliases = $input['aliases'] ?? []; $site->aliases = $input['aliases'] ?? [];
/** @var Service $service */
$service = $site->server->webserver();
/** @var Webserver $webserver */ /** @var Webserver $webserver */
$webserver = $site->server->webserver()->handler(); $webserver = $service->handler();
$webserver->updateVHost($site); $webserver->updateVHost($site);
$site->save(); $site->save();
} }
/**
* @return array<string, array<int, mixed>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -5,12 +5,12 @@
use App\Exceptions\SSHError; use App\Exceptions\SSHError;
use App\Models\Site; use App\Models\Site;
use App\SSH\Git\Git; use App\SSH\Git\Git;
use Illuminate\Validation\ValidationException;
class UpdateBranch class UpdateBranch
{ {
/** /**
* @throws ValidationException * @param array<string, mixed> $input
*
* @throws SSHError * @throws SSHError
*/ */
public function update(Site $site, array $input): void public function update(Site $site, array $input): void
@ -22,7 +22,7 @@ public function update(Site $site, array $input): void
} }
/** /**
* @throws ValidationException * @return array<string, string>
*/ */
public static function rules(): array public static function rules(): array
{ {

View File

@ -2,23 +2,24 @@
namespace App\Actions\Site; namespace App\Actions\Site;
use App\Models\DeploymentScript;
use App\Models\Site; use App\Models\Site;
use Illuminate\Validation\ValidationException;
class UpdateDeploymentScript class UpdateDeploymentScript
{ {
/** /**
* @throws ValidationException * @param array<string, mixed> $input
*/ */
public function update(Site $site, array $input): void public function update(Site $site, array $input): void
{ {
/** @var DeploymentScript $script */
$script = $site->deploymentScript; $script = $site->deploymentScript;
$script->content = $input['script']; $script->content = $input['script'];
$script->save(); $script->save();
} }
/** /**
* @throws ValidationException * @return array<string, array<string>>
*/ */
public static function rules(): array public static function rules(): array
{ {

View File

@ -8,6 +8,8 @@
class UpdateEnv class UpdateEnv
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws SSHError * @throws SSHError
*/ */
public function update(Site $site, array $input): void public function update(Site $site, array $input): void
@ -15,7 +17,7 @@ public function update(Site $site, array $input): void
$site->server->os()->editFileAs( $site->server->os()->editFileAs(
$site->path.'/.env', $site->path.'/.env',
$site->user, $site->user,
trim($input['env']), trim((string) $input['env']),
); );
} }
} }

View File

@ -9,6 +9,9 @@
class UpdateLoadBalancer class UpdateLoadBalancer
{ {
/**
* @param array<string, mixed> $input
*/
public function update(Site $site, array $input): void public function update(Site $site, array $input): void
{ {
$site->loadBalancerServers()->delete(); $site->loadBalancerServers()->delete();
@ -27,6 +30,9 @@ public function update(Site $site, array $input): void
$site->webserver()->updateVHost($site); $site->webserver()->updateVHost($site);
} }
/**
* @return array<string, array<int, mixed>>
*/
public static function rules(Site $site): array public static function rules(Site $site): array
{ {
return [ return [

View File

@ -8,6 +8,9 @@
class UpdatePHPVersion class UpdatePHPVersion
{ {
/**
* @return array<string, array<string>>
*/
public static function rules(Site $site): array public static function rules(Site $site): array
{ {
return [ return [
@ -21,6 +24,8 @@ public static function rules(Site $site): array
} }
/** /**
* @param array<string, mixed> $input
*
* @throws SSHError * @throws SSHError
*/ */
public function update(Site $site, array $input): void public function update(Site $site, array $input): void

View File

@ -11,12 +11,17 @@
class UpdateSourceControl class UpdateSourceControl
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function update(Site $site, array $input): void public function update(Site $site, array $input): void
{ {
$site->source_control_id = $input['source_control']; $site->source_control_id = $input['source_control'];
try { try {
if ($site->sourceControl) { if ($site->sourceControl) {
$site->sourceControl?->getRepo($site->repository); $site->sourceControl->getRepo($site->repository);
} }
} catch (SourceControlIsNotConnected) { } catch (SourceControlIsNotConnected) {
throw ValidationException::withMessages([ throw ValidationException::withMessages([
@ -34,6 +39,9 @@ public function update(Site $site, array $input): void
$site->save(); $site->save();
} }
/**
* @return array<string, array<int, mixed>>
*/
public static function rules(): array public static function rules(): array
{ {
return [ return [

View File

@ -4,14 +4,18 @@
use App\Models\Project; use App\Models\Project;
use App\Models\SourceControl; use App\Models\SourceControl;
use App\Models\User;
use Illuminate\Support\Arr; use Illuminate\Support\Arr;
use Illuminate\Validation\Rule; use Illuminate\Validation\Rule;
use Illuminate\Validation\ValidationException; use Illuminate\Validation\ValidationException;
class ConnectSourceControl class ConnectSourceControl
{ {
public function connect(User $user, Project $project, array $input): SourceControl /**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function connect(Project $project, array $input): SourceControl
{ {
$sourceControl = new SourceControl([ $sourceControl = new SourceControl([
'provider' => $input['provider'], 'provider' => $input['provider'],
@ -34,6 +38,10 @@ public function connect(User $user, Project $project, array $input): SourceContr
return $sourceControl; return $sourceControl;
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<int, mixed>>
*/
public static function rules(array $input): array public static function rules(array $input): array
{ {
$rules = [ $rules = [
@ -46,10 +54,13 @@ public static function rules(array $input): array
], ],
]; ];
return array_merge($rules, static::providerRules($input)); return array_merge($rules, self::providerRules($input));
} }
/** /**
* @param array<string, mixed> $input
* @return array<string, array<string>>
*
* @throws ValidationException * @throws ValidationException
*/ */
private static function providerRules(array $input): array private static function providerRules(array $input): array

View File

@ -8,6 +8,11 @@
class EditSourceControl class EditSourceControl
{ {
/**
* @param array<string, mixed> $input
*
* @throws ValidationException
*/
public function edit(SourceControl $sourceControl, Project $project, array $input): SourceControl public function edit(SourceControl $sourceControl, Project $project, array $input): SourceControl
{ {
$sourceControl->profile = $input['name']; $sourceControl->profile = $input['name'];
@ -27,6 +32,10 @@ public function edit(SourceControl $sourceControl, Project $project, array $inpu
return $sourceControl; return $sourceControl;
} }
/**
* @param array<string, mixed> $input
* @return array<string, array<int, mixed>>
*/
public static function rules(SourceControl $sourceControl, array $input): array public static function rules(SourceControl $sourceControl, array $input): array
{ {
$rules = [ $rules = [
@ -35,10 +44,13 @@ public static function rules(SourceControl $sourceControl, array $input): array
], ],
]; ];
return array_merge($rules, static::providerRules($sourceControl, $input)); return array_merge($rules, self::providerRules($sourceControl, $input));
} }
/** /**
* @param array<string, mixed> $input
* @return array<string, array<int, mixed>>
*
* @throws ValidationException * @throws ValidationException
*/ */
private static function providerRules(SourceControl $sourceControl, array $input): array private static function providerRules(SourceControl $sourceControl, array $input): array

View File

@ -10,6 +10,8 @@
class CreateSshKey class CreateSshKey
{ {
/** /**
* @param array<string, mixed> $input
*
* @throws ValidationException * @throws ValidationException
*/ */
public function create(User $user, array $input): SshKey public function create(User $user, array $input): SshKey
@ -25,7 +27,7 @@ public function create(User $user, array $input): SshKey
} }
/** /**
* @throws ValidationException * @return array<string, mixed>
*/ */
public static function rules(): array public static function rules(): array
{ {

Some files were not shown because too many files have changed in this diff Show More