mirror of
https://github.com/vitodeploy/vito.git
synced 2025-07-01 14:06:15 +00:00
Compare commits
110 Commits
Author | SHA1 | Date | |
---|---|---|---|
1da1d5d413 | |||
f3df6b8673 | |||
f532b56abb | |||
194143d7ef | |||
73c836bfe7 | |||
ad5af0cd9e | |||
15d8cb1705 | |||
f4414a931e | |||
a593525939 | |||
a2841f673b | |||
231e90076f | |||
dc7fa6b55c | |||
5689e751af | |||
e59448d30a | |||
346bd03f4f | |||
085504605b | |||
d1a7eb24a7 | |||
c10a3ee4bb | |||
dd14e69239 | |||
736e27fa4e | |||
961d2021bd | |||
e52500ad47 | |||
3732d690db | |||
a123145d84 | |||
ada56065cb | |||
a3db7cbc85 | |||
d2eb2c4e4a | |||
7bfa9ef91d | |||
3196c0d954 | |||
45521d2616 | |||
7a94e28da2 | |||
cf9bb35615 | |||
9a3578f3ac | |||
632a56bf4d | |||
f97fffe654 | |||
2081bdd46e | |||
48c4d53d31 | |||
69939f8aad | |||
798542673f | |||
49c29de962 | |||
342a3aa4c6 | |||
131b828807 | |||
adc0653d15 | |||
c6ed3f029d | |||
eceacffb0d | |||
09a9735962 | |||
4e6491a080 | |||
8e8859b305 | |||
56baba74d7 | |||
ab68964d43 | |||
0bd390f27c | |||
f8f8d57fe2 | |||
35894003f5 | |||
c3f69f3247 | |||
efacadba10 | |||
84476db764 | |||
41388dafbf | |||
0b7dd1732b | |||
c09c7a63fa | |||
857319025f | |||
104cd2fce8 | |||
1b9f826bcb | |||
0fce4dba9c | |||
8b6f65db97 | |||
984c1f3a8e | |||
61506ff70e | |||
6032bd1098 | |||
f5fdbae4ac | |||
ff11fb44e0 | |||
a5ce0d33b3 | |||
a40c2828c2 | |||
fe3317692b | |||
2850c1fa59 | |||
eb86204069 | |||
f7ac3c32f0 | |||
61faaabb85 | |||
04d52f6742 | |||
cdc012c270 | |||
563b9c5909 | |||
5a00d35eba | |||
1ed5d7362b | |||
8b4d156afa | |||
edd4ba1bc2 | |||
b8ba83949b | |||
a81e9b18b7 | |||
38bafd7654 | |||
6eb88c7c6e | |||
76059aff3c | |||
ff4d560e44 | |||
dda345f565 | |||
564b97e2aa | |||
4e5f975917 | |||
f3500497d0 | |||
996df64386 | |||
e98e974e20 | |||
2a670146d8 | |||
f483f7fdca | |||
7882d2022c | |||
03be2d3ee2 | |||
f89e7af34e | |||
7886e2a113 | |||
72352aad8d | |||
48ae561ea4 | |||
0f06d81aac | |||
493cbb0849 | |||
c22bb1fa80 | |||
babf59350b | |||
5a12ed76bb | |||
269ee8d962 | |||
a060a06e73 |
@ -3,12 +3,15 @@ root = true
|
|||||||
[*]
|
[*]
|
||||||
charset = utf-8
|
charset = utf-8
|
||||||
end_of_line = lf
|
end_of_line = lf
|
||||||
indent_size = 4
|
indent_size = 2
|
||||||
indent_style = space
|
indent_style = space
|
||||||
insert_final_newline = true
|
insert_final_newline = true
|
||||||
trim_trailing_whitespace = true
|
trim_trailing_whitespace = true
|
||||||
ij_any_block_comment_at_first_column = false
|
ij_any_block_comment_at_first_column = false
|
||||||
|
|
||||||
|
[{*.php,composer.json,composer.lock}]
|
||||||
|
indent_size = 4
|
||||||
|
|
||||||
[*.md]
|
[*.md]
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
|
@ -15,3 +15,6 @@ MAIL_PASSWORD=null
|
|||||||
MAIL_ENCRYPTION=null
|
MAIL_ENCRYPTION=null
|
||||||
MAIL_FROM_ADDRESS="noreply@${APP_NAME}"
|
MAIL_FROM_ADDRESS="noreply@${APP_NAME}"
|
||||||
MAIL_FROM_NAME="${APP_NAME}"
|
MAIL_FROM_NAME="${APP_NAME}"
|
||||||
|
|
||||||
|
REDIS_HOST=redis
|
||||||
|
REDIS_PORT=6379
|
||||||
|
44
.github/workflows/code-quality.yml
vendored
Normal file
44
.github/workflows/code-quality.yml
vendored
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
name: code-quality
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- 2.x
|
||||||
|
- 3.x
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- 2.x
|
||||||
|
- 3.x
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
tests:
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: true
|
||||||
|
matrix:
|
||||||
|
php: [ 8.4 ]
|
||||||
|
|
||||||
|
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
|
11
.github/workflows/code-style.yml
vendored
11
.github/workflows/code-style.yml
vendored
@ -6,6 +6,7 @@ on:
|
|||||||
- main
|
- main
|
||||||
- 1.x
|
- 1.x
|
||||||
- 2.x
|
- 2.x
|
||||||
|
- 3.x
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@ -15,11 +16,11 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: true
|
fail-fast: true
|
||||||
matrix:
|
matrix:
|
||||||
php: [ 8.2 ]
|
php: [ 8.4 ]
|
||||||
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 +29,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,12 +44,12 @@ 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"
|
||||||
|
|
||||||
- name: Install NPM Dependencies
|
- name: Install NPM Dependencies
|
||||||
run: npm install
|
run: npm install --force
|
||||||
|
|
||||||
- name: Run lint
|
- name: Run lint
|
||||||
run: npm run lint
|
run: npm run lint
|
||||||
|
8
.github/workflows/docker-latest.yml
vendored
8
.github/workflows/docker-latest.yml
vendored
@ -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 }}
|
||||||
|
8
.github/workflows/docker-release.yml
vendored
8
.github/workflows/docker-release.yml
vendored
@ -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 }}
|
||||||
|
23
.github/workflows/tests.yml
vendored
23
.github/workflows/tests.yml
vendored
@ -6,6 +6,7 @@ on:
|
|||||||
- main
|
- main
|
||||||
- 1.x
|
- 1.x
|
||||||
- 2.x
|
- 2.x
|
||||||
|
- 3.x
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@ -15,10 +16,11 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: true
|
fail-fast: true
|
||||||
matrix:
|
matrix:
|
||||||
php: [ 8.2 ]
|
php: [ 8.4 ]
|
||||||
|
node-version: [ "22.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
|
||||||
@ -27,12 +29,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
|
||||||
@ -43,5 +46,19 @@ jobs:
|
|||||||
- name: Set up the .env file
|
- name: Set up the .env file
|
||||||
run: touch .env
|
run: touch .env
|
||||||
|
|
||||||
|
- name: Generate Application Key
|
||||||
|
run: php artisan key:generate
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: "22.x"
|
||||||
|
|
||||||
|
- name: Install NPM Dependencies
|
||||||
|
run: npm install --force
|
||||||
|
|
||||||
|
- name: Build assets
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
- name: Run test suite
|
- name: Run test suite
|
||||||
run: php artisan test
|
run: php artisan test
|
||||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -22,3 +22,4 @@ yarn-error.log
|
|||||||
/.idea
|
/.idea
|
||||||
/.vscode
|
/.vscode
|
||||||
laradumps.yaml
|
laradumps.yaml
|
||||||
|
/public/build
|
||||||
|
@ -13,3 +13,6 @@ sail
|
|||||||
!*.blade.php
|
!*.blade.php
|
||||||
!*.sh
|
!*.sh
|
||||||
resources/views/ssh/
|
resources/views/ssh/
|
||||||
|
resources/views/scribe/
|
||||||
|
resources/js/ziggy.js
|
||||||
|
resources/views/mail/*
|
||||||
|
68
.prettierrc
68
.prettierrc
@ -1,26 +1,46 @@
|
|||||||
{
|
{
|
||||||
"plugins": [
|
"semi": true,
|
||||||
"prettier-plugin-blade",
|
"singleQuote": true,
|
||||||
"prettier-plugin-tailwindcss",
|
"singleAttributePerLine": false,
|
||||||
"prettier-plugin-sh"
|
"htmlWhitespaceSensitivity": "css",
|
||||||
],
|
"printWidth": 150,
|
||||||
"overrides": [
|
"tailwindFunctions": [
|
||||||
{
|
"clsx",
|
||||||
"files": ["*.blade.php"],
|
"cn"
|
||||||
"options": {
|
],
|
||||||
"parser": "blade",
|
"tabWidth": 2,
|
||||||
"printWidth": 120,
|
"plugins": [
|
||||||
"htmlWhitespaceSensitivity": "ignore",
|
"prettier-plugin-blade",
|
||||||
"tabWidth": 4,
|
"prettier-plugin-tailwindcss",
|
||||||
"quoteProps": "consistent",
|
"prettier-plugin-sh"
|
||||||
"trailingComma": "none"
|
],
|
||||||
}
|
"overrides": [
|
||||||
},
|
{
|
||||||
{
|
"files": [
|
||||||
"files": ["*.sh"],
|
"*.blade.php"
|
||||||
"options": {
|
],
|
||||||
"parser": "sh"
|
"options": {
|
||||||
}
|
"parser": "blade",
|
||||||
}
|
"printWidth": 120,
|
||||||
]
|
"htmlWhitespaceSensitivity": "ignore",
|
||||||
|
"tabWidth": 4,
|
||||||
|
"quoteProps": "consistent",
|
||||||
|
"trailingComma": "none"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"files": [
|
||||||
|
"*.sh"
|
||||||
|
],
|
||||||
|
"options": {
|
||||||
|
"parser": "sh"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"files": "**/*.yml",
|
||||||
|
"options": {
|
||||||
|
"tabWidth": 2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
|
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
|
||||||
# Scribe uses this file to know when you change something manually in your docs.
|
# Scribe uses this file to know when you change something manually in your docs.
|
||||||
.scribe/intro.md=98adb6862b118c06e02e4e22390feb6f
|
.scribe/intro.md=ce7ca21baf0406f807aed85ee1d8fa6e
|
||||||
.scribe/auth.md=7fcc12b2e5a86fa9c49f509d348f3cc2
|
.scribe/auth.md=9bee2b1ef8a238b2e58613fa636d5f39
|
@ -1,7 +1,3 @@
|
|||||||
# Authenticating requests
|
# Authenticating requests
|
||||||
|
|
||||||
To authenticate requests, include an **`Authorization`** header with the value **`"Bearer YOUR-API-KEY"`**.
|
This API is not authenticated.
|
||||||
|
|
||||||
All authenticated endpoints are marked with a `requires authentication` badge in the documentation below.
|
|
||||||
|
|
||||||
You can retrieve your token by visiting <a href="/settings/api-keys" target="_blank">here</a>
|
|
||||||
|
@ -1,219 +1,160 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: cron-jobs
|
name: Endpoints
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
|
||||||
metadata:
|
|
||||||
groupName: cron-jobs
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: list
|
|
||||||
description: 'Get all cron jobs.'
|
|
||||||
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: 200
|
|
||||||
content: '{"data":[{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer ge6ZVa4kfD86hdv5a31EcbP'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
uri: 'api/servers/{server_id}/agent/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: cron-jobs
|
groupName: Endpoints
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: ''
|
||||||
description: 'Create a new cron job.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
project_id:
|
server_id:
|
||||||
name: project_id
|
name: server_id
|
||||||
description: 'The ID of the project.'
|
description: 'The ID of the server.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
server_id:
|
id:
|
||||||
name: server_id
|
name: id
|
||||||
description: 'The ID of the server.'
|
description: 'The ID of the agent.'
|
||||||
required: true
|
required: true
|
||||||
example: 8
|
example: architecto
|
||||||
type: integer
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
server_id: 6
|
||||||
server_id: 8
|
id: architecto
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
command:
|
load:
|
||||||
name: command
|
name: load
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: itaque
|
example: 4326.41688
|
||||||
type: string
|
type: number
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
user:
|
memory_total:
|
||||||
name: user
|
name: memory_total
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: root
|
example: 4326.41688
|
||||||
type: string
|
type: number
|
||||||
enumValues:
|
enumValues: []
|
||||||
- root
|
|
||||||
- vito
|
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
frequency:
|
memory_used:
|
||||||
name: frequency
|
name: memory_used
|
||||||
description: 'Frequency of the cron job.'
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: '* * * * *'
|
example: 4326.41688
|
||||||
type: string
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
memory_free:
|
||||||
|
name: memory_free
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
disk_total:
|
||||||
|
name: disk_total
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
disk_used:
|
||||||
|
name: disk_used
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
disk_free:
|
||||||
|
name: disk_free
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
command: itaque
|
load: 4326.41688
|
||||||
user: root
|
memory_total: 4326.41688
|
||||||
frequency: '* * * * *'
|
memory_used: 4326.41688
|
||||||
|
memory_free: 4326.41688
|
||||||
|
disk_total: 4326.41688
|
||||||
|
disk_used: 4326.41688
|
||||||
|
disk_free: 4326.41688
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses: []
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer cdh5bD8gVPkf34e1ZEva6a6'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
custom: []
|
custom: []
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
0: GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
2: POST
|
||||||
|
3: PUT
|
||||||
|
4: PATCH
|
||||||
|
5: DELETE
|
||||||
|
6: OPTIONS
|
||||||
|
uri: api/git-hooks
|
||||||
metadata:
|
metadata:
|
||||||
groupName: cron-jobs
|
groupName: Endpoints
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: ''
|
||||||
description: 'Get a cron job by ID.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters: []
|
||||||
project_id:
|
cleanUrlParameters: []
|
||||||
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: []
|
|
||||||
cronJob_id:
|
|
||||||
name: cronJob_id
|
|
||||||
description: 'The ID of the cronJob.'
|
|
||||||
required: true
|
|
||||||
example: 18
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
cronJob_id: 18
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -221,89 +162,21 @@ endpoints:
|
|||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
status: 404
|
||||||
content: '{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null}'
|
content: |-
|
||||||
headers: []
|
{
|
||||||
description: ''
|
"message": ""
|
||||||
|
}
|
||||||
|
headers:
|
||||||
|
cache-control: 'no-cache, private'
|
||||||
|
content-type: application/json
|
||||||
|
x-ratelimit-limit: '60'
|
||||||
|
x-ratelimit-remaining: '57'
|
||||||
|
access-control-allow-origin: '*'
|
||||||
|
description: null
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer fa5VgdkaD8cZ6vh34Pb16eE'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: cron-jobs
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: delete
|
|
||||||
description: 'Delete cron job.'
|
|
||||||
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: []
|
|
||||||
cronJob_id:
|
|
||||||
name: cronJob_id
|
|
||||||
description: 'The ID of the cronJob.'
|
|
||||||
required: true
|
|
||||||
example: 10
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
cronJob_id: 10
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 204
|
|
||||||
content: null
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P8hkva3ZD4fgb166adEVce5'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: databases
|
name: cron-jobs
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all databases.'
|
description: 'Get all cron jobs.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -35,7 +34,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -43,7 +42,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -52,15 +51,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":3,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":4,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Z641ebPacDV6f38kEgdah5v'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -68,18 +64,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new database.'
|
description: 'Create a new cron job.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -97,7 +92,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -105,35 +100,56 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
name:
|
command:
|
||||||
name: name
|
name: command
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: et
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
user:
|
||||||
|
name: user
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: vito
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- root
|
||||||
|
- vito
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
frequency:
|
||||||
|
name: frequency
|
||||||
|
description: 'Frequency of the cron job.'
|
||||||
|
required: true
|
||||||
|
example: '* * * * *'
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
name: et
|
command: architecto
|
||||||
|
user: vito
|
||||||
|
frequency: '* * * * *'
|
||||||
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":3,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer d4gbv56caV3aZ8D1h6kfEPe'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -141,18 +157,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a database by ID.'
|
description: 'Get a cron job by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -170,17 +185,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
id:
|
cronJob_id:
|
||||||
name: id
|
name: cronJob_id
|
||||||
description: 'The ID of the database.'
|
description: 'The ID of the cronJob.'
|
||||||
required: true
|
required: true
|
||||||
example: 19
|
example: 1
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -188,8 +203,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
id: 19
|
cronJob_id: 1
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -198,15 +213,12 @@ 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":3,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P68VgDcaEZvk63f4b5aed1h'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -214,18 +226,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{database_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete database.'
|
description: 'Delete cron job.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -243,17 +254,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
database_id:
|
cronJob_id:
|
||||||
name: database_id
|
name: cronJob_id
|
||||||
description: 'The ID of the database.'
|
description: 'The ID of the cronJob.'
|
||||||
required: true
|
required: true
|
||||||
example: 15
|
example: 1
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -261,8 +272,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
database_id: 15
|
cronJob_id: 1
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -276,10 +287,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer DkPc6d1heEv5a8fb4V63agZ'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: database-users
|
name: databases
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: database-users
|
groupName: databases
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all database users.'
|
description: 'Get all databases.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -35,330 +34,6 @@ 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
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P4gD36fZeckvVh5ab86Ead1'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: create
|
|
||||||
description: 'Create a new database user.'
|
|
||||||
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:
|
|
||||||
username:
|
|
||||||
name: username
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: consequuntur
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
password:
|
|
||||||
name: password
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: 'fI/i2.O4u&dla?eXvR2'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
host:
|
|
||||||
name: host
|
|
||||||
description: 'Host, if it is a remote user.'
|
|
||||||
required: true
|
|
||||||
example: '%'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
username: consequuntur
|
|
||||||
password: 'fI/i2.O4u&dla?eXvR2'
|
|
||||||
host: '%'
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"username":"kari.farrell","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5k8Vced1baaE6f4ZvDPgh36'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: show
|
|
||||||
description: 'Get a database user 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: []
|
|
||||||
server_id:
|
|
||||||
name: server_id
|
|
||||||
description: 'The ID of the server.'
|
|
||||||
required: true
|
|
||||||
example: 8
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
databaseUser_id:
|
|
||||||
name: databaseUser_id
|
|
||||||
description: 'The ID of the databaseUser.'
|
|
||||||
required: true
|
|
||||||
example: 18
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
databaseUser_id: 18
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"username":"caterina.mosciski","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 3kDveP5V8a6dghfa4E16cbZ'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}/link'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: link
|
|
||||||
description: 'Link to databases'
|
|
||||||
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: []
|
|
||||||
databaseUser_id:
|
|
||||||
name: databaseUser_id
|
|
||||||
description: 'The ID of the databaseUser.'
|
|
||||||
required: true
|
|
||||||
example: 4
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
databaseUser_id: 4
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
databases:
|
|
||||||
name: databases
|
|
||||||
description: 'Array of database names to link to the user.'
|
|
||||||
required: true
|
|
||||||
example: non
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
databases: non
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"username":"kurtis05","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer DgPea43EvV51a866dfbZckh'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: delete
|
|
||||||
description: 'Delete database user.'
|
|
||||||
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: []
|
|
||||||
databaseUser_id:
|
|
||||||
name: databaseUser_id
|
|
||||||
description: 'The ID of the databaseUser.'
|
|
||||||
required: true
|
|
||||||
example: 6
|
example: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
@ -367,8 +42,236 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
databaseUser_id: 6
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"data":[{"id":9,"server_id":1,"name":"zbailey","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":10,"server_id":1,"name":"rempel.chadrick","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
||||||
|
metadata:
|
||||||
|
groupName: databases
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: 'Create a new database.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
charset:
|
||||||
|
name: charset
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
collation:
|
||||||
|
name: collation
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
name: architecto
|
||||||
|
charset: architecto
|
||||||
|
collation: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":9,"server_id":1,"name":"zbailey","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{id}'
|
||||||
|
metadata:
|
||||||
|
groupName: databases
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: 'Get a database by ID.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
id:
|
||||||
|
name: id
|
||||||
|
description: 'The ID of the database.'
|
||||||
|
required: true
|
||||||
|
example: 8
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
id: 8
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":9,"server_id":1,"name":"rempel.chadrick","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{database_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: databases
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: 'Delete database.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
database_id:
|
||||||
|
name: database_id
|
||||||
|
description: 'The ID of the database.'
|
||||||
|
required: true
|
||||||
|
example: 8
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
database_id: 8
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -382,10 +285,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 6ackVP8hEZd3164gD5evafb'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: firewall-rules
|
name: database-users
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all firewall rules.'
|
description: 'Get all database users.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -35,7 +34,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -43,7 +42,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -52,15 +51,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":4,"server_id":1,"username":"cartwright.maxine","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":5,"server_id":1,"username":"gusikowski.eden","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer h3P5gD8E4dkeZ6abac6vfV1'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -68,18 +64,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new firewall rule.'
|
description: 'Create a new database user.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -97,7 +92,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -105,83 +100,54 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
type:
|
username:
|
||||||
name: type
|
name: username
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: deny
|
example: architecto
|
||||||
type: string
|
|
||||||
enumValues:
|
|
||||||
- allow
|
|
||||||
- deny
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
protocol:
|
|
||||||
name: protocol
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: udp
|
|
||||||
type: string
|
|
||||||
enumValues:
|
|
||||||
- tcp
|
|
||||||
- udp
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
port:
|
|
||||||
name: port
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: et
|
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
source:
|
password:
|
||||||
name: source
|
name: password
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: voluptates
|
example: '|]|{+-'
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
mask:
|
host:
|
||||||
name: mask
|
name: host
|
||||||
description: 'Mask for source IP.'
|
description: 'Host, if it is a remote user.'
|
||||||
required: true
|
required: true
|
||||||
example: '0'
|
example: '%'
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
type: deny
|
username: architecto
|
||||||
protocol: udp
|
password: '|]|{+-'
|
||||||
port: et
|
host: '%'
|
||||||
source: voluptates
|
|
||||||
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":4,"server_id":1,"username":"justina.gaylord","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 6a8DVv5k3gZfEe6hb1daPc4'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -189,18 +155,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a firewall rule by ID.'
|
description: 'Get a database user by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -218,17 +183,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
firewallRule_id:
|
databaseUser_id:
|
||||||
name: firewallRule_id
|
name: databaseUser_id
|
||||||
description: 'The ID of the firewallRule.'
|
description: 'The ID of the databaseUser.'
|
||||||
required: true
|
required: true
|
||||||
example: 29
|
example: 16
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -236,8 +201,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
firewallRule_id: 29
|
databaseUser_id: 16
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -246,34 +211,30 @@ 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":4,"server_id":1,"username":"zbailey","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P4bZdV1geED3kfh568aa6cv'
|
|
||||||
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}/firewall-rules/{firewallRule_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}/link'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: link
|
||||||
description: 'Delete firewall rule.'
|
description: 'Link to databases'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -291,17 +252,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
firewallRule_id:
|
databaseUser_id:
|
||||||
name: firewallRule_id
|
name: databaseUser_id
|
||||||
description: 'The ID of the firewallRule.'
|
description: 'The ID of the databaseUser.'
|
||||||
required: true
|
required: true
|
||||||
example: 29
|
example: 16
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -309,8 +270,88 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
firewallRule_id: 29
|
databaseUser_id: 16
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
databases:
|
||||||
|
name: databases
|
||||||
|
description: 'Array of database names to link to the user.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
databases: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"server_id":1,"username":"zbailey","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: database-users
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: 'Delete database user.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
databaseUser_id:
|
||||||
|
name: databaseUser_id
|
||||||
|
description: 'The ID of the databaseUser.'
|
||||||
|
required: true
|
||||||
|
example: 16
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
databaseUser_id: 16
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -324,10 +365,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Dh3kcaafdg6E5ZvV46ePb81'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,26 +1,48 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: general
|
name: firewall-rules
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: api/health
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: general
|
groupName: firewall-rules
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: health-check
|
title: list
|
||||||
description: ''
|
description: 'Get all firewall rules.'
|
||||||
authenticated: false
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters: []
|
urlParameters:
|
||||||
cleanUrlParameters: []
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -29,14 +51,414 @@ endpoints:
|
|||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
status: 200
|
||||||
content: '{"success":true,"version":"2.1.0"}'
|
content: '{"data":[{"id":22,"name":"eius","server_id":1,"type":"allow","protocol":"tcp","port":9322,"source":"113.14.236.204","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":23,"name":"velit","server_id":1,"type":"allow","protocol":"tcp","port":2983,"source":"199.172.126.144","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers:
|
headers: []
|
||||||
cache-control: 'no-cache, private'
|
description: ''
|
||||||
content-type: application/json
|
custom: []
|
||||||
x-ratelimit-limit: '60'
|
responseFields: []
|
||||||
x-ratelimit-remaining: '59'
|
auth: []
|
||||||
access-control-allow-origin: '*'
|
controller: null
|
||||||
description: null
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
||||||
|
metadata:
|
||||||
|
groupName: firewall-rules
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: 'Create a new firewall rule.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
source:
|
||||||
|
name: source
|
||||||
|
description: ''
|
||||||
|
required: false
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
type: allow
|
||||||
|
protocol: tcp
|
||||||
|
port: architecto
|
||||||
|
source: architecto
|
||||||
|
mask: '0'
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":22,"name":"eius","server_id":1,"type":"allow","protocol":"tcp","port":9322,"source":"113.14.236.204","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
firewallRule_id:
|
||||||
|
name: firewallRule_id
|
||||||
|
description: 'The ID of the firewallRule.'
|
||||||
|
required: true
|
||||||
|
example: 19
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
firewallRule_id: 19
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
type:
|
||||||
|
name: type
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: deny
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- allow
|
||||||
|
- deny
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
protocol:
|
||||||
|
name: protocol
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: udp
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- tcp
|
||||||
|
- udp
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
port:
|
||||||
|
name: port
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
source:
|
||||||
|
name: source
|
||||||
|
description: ''
|
||||||
|
required: false
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
type: deny
|
||||||
|
protocol: udp
|
||||||
|
port: architecto
|
||||||
|
source: architecto
|
||||||
|
mask: '0'
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":22,"name":"eius","server_id":1,"type":"allow","protocol":"tcp","port":9322,"source":"113.14.236.204","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: firewall-rules
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: 'Get a firewall rule by ID.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
firewallRule_id:
|
||||||
|
name: firewallRule_id
|
||||||
|
description: 'The ID of the firewallRule.'
|
||||||
|
required: true
|
||||||
|
example: 19
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
firewallRule_id: 19
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":22,"name":"velit","server_id":1,"type":"allow","protocol":"tcp","port":2983,"source":"199.172.126.144","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: firewall-rules
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: 'Delete firewall rule.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
firewallRule_id:
|
||||||
|
name: firewallRule_id
|
||||||
|
description: 'The ID of the firewallRule.'
|
||||||
|
required: true
|
||||||
|
example: 19
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
firewallRule_id: 19
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth: []
|
auth: []
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: projects
|
name: general
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: api/projects
|
uri: api/health
|
||||||
metadata:
|
metadata:
|
||||||
groupName: projects
|
groupName: general
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: health-check
|
||||||
description: 'Get all projects.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters: []
|
urlParameters: []
|
||||||
@ -30,230 +29,17 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"success":true,"version":"2.5.0"}'
|
||||||
headers: []
|
headers:
|
||||||
description: ''
|
cache-control: 'no-cache, private'
|
||||||
|
content-type: application/json
|
||||||
|
x-ratelimit-limit: '60'
|
||||||
|
x-ratelimit-remaining: '56'
|
||||||
|
access-control-allow-origin: '*'
|
||||||
|
description: null
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5DaveP3d6b6khEZVcg4fa18'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: api/projects
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: create
|
|
||||||
description: 'Create a new project.'
|
|
||||||
authenticated: true
|
|
||||||
custom: []
|
|
||||||
headers:
|
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
|
||||||
Accept: application/json
|
|
||||||
urlParameters: []
|
|
||||||
cleanUrlParameters: []
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the project.'
|
|
||||||
required: true
|
|
||||||
example: quos
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
name: quos
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":3,"name":"Isidro Franecki","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer a6P53EvkcZV6D4ghad1efb8'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{id}'
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: show
|
|
||||||
description: 'Get a project by ID.'
|
|
||||||
authenticated: true
|
|
||||||
custom: []
|
|
||||||
headers:
|
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
|
||||||
Accept: application/json
|
|
||||||
urlParameters:
|
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the project.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
id: 1
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":3,"name":"Rhoda Parisian","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer v48Ve5ZghdcbE1akP66fD3a'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- PUT
|
|
||||||
uri: 'api/projects/{id}'
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: update
|
|
||||||
description: 'Update project.'
|
|
||||||
authenticated: true
|
|
||||||
custom: []
|
|
||||||
headers:
|
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
|
||||||
Accept: application/json
|
|
||||||
urlParameters:
|
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the project.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
id: 1
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the project.'
|
|
||||||
required: true
|
|
||||||
example: ullam
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
name: ullam
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer fvEdh3Vgbk56Z4a61eP8caD'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: delete
|
|
||||||
description: 'Delete project.'
|
|
||||||
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: 204
|
|
||||||
content: null
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer eg4c3vZ1Dhaa68d6PEfk5bV'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,38 +1,26 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: servers
|
name: projects
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers'
|
uri: api/projects
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all servers in a project.'
|
description: 'Get all projects.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters: []
|
||||||
project_id:
|
cleanUrlParameters: []
|
||||||
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: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -41,15 +29,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":3,"name":"Belle Dickens","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":4,"name":"Mittie Considine","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer E81avahec6365dbZfgD4kPV'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -57,198 +42,46 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers'
|
uri: api/projects
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new server.'
|
description: 'Create a new project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters: []
|
||||||
project_id:
|
cleanUrlParameters: []
|
||||||
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: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
provider:
|
|
||||||
name: provider
|
|
||||||
description: 'The server provider type'
|
|
||||||
required: true
|
|
||||||
example: iste
|
|
||||||
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: custom
|
|
||||||
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: 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: name
|
name: name
|
||||||
description: 'The name of the server.'
|
description: 'The name of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: illum
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
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
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
provider: iste
|
name: architecto
|
||||||
server_provider: custom
|
|
||||||
region: libero
|
|
||||||
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}'
|
content: '{"id":3,"name":"Ms. Elisabeth Okuneva","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer aad3Pvc4e65DghZVEk8f1b6'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -256,23 +89,22 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{id}'
|
uri: 'api/projects/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a server by ID.'
|
description: 'Get a project by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
project_id:
|
id:
|
||||||
name: project_id
|
name: id
|
||||||
description: 'The ID of the project.'
|
description: 'The ID of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 1
|
||||||
@ -281,19 +113,8 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the server.'
|
|
||||||
required: true
|
|
||||||
example: 8
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
id: 1
|
||||||
id: 8
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -302,39 +123,35 @@ endpoints:
|
|||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
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}'
|
content: '{"id":3,"name":"Aleen O''Kon","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5EhD3v6Z8Vdakfg46eP1cab'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
custom: []
|
custom: []
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- PUT
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/reboot'
|
uri: 'api/projects/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: reboot
|
title: update
|
||||||
description: 'Reboot a server.'
|
description: 'Update project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
project_id:
|
id:
|
||||||
name: project_id
|
name: id
|
||||||
description: 'The ID of the project.'
|
description: 'The ID of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 1
|
||||||
@ -343,98 +160,33 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
server_id:
|
cleanUrlParameters:
|
||||||
name: server_id
|
id: 1
|
||||||
description: 'The ID of the server.'
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: 8
|
example: architecto
|
||||||
type: integer
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanBodyParameters:
|
||||||
project_id: 1
|
name: architecto
|
||||||
server_id: 8
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 204
|
status: 200
|
||||||
content: null
|
content: '{"id":3,"name":"Ms. Elisabeth Okuneva","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Pc5Da6Vhdk1vag6fE84e3Zb'
|
|
||||||
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,18 +194,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}'
|
uri: 'api/projects/{project_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete server.'
|
description: 'Delete project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -467,19 +218,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: []
|
||||||
@ -493,10 +233,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer haE8D6Z6gePk1vadVb53c4f'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,74 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: server-providers
|
name: redirects
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/server-providers'
|
|
||||||
metadata:
|
|
||||||
groupName: server-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":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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Df16eda8Pa345EkgbZ6cvhV'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/server-providers'
|
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: server-providers
|
groupName: redirects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: ''
|
description: 'Create a new redirect.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -82,228 +30,81 @@ 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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
site_id:
|
||||||
|
name: site_id
|
||||||
|
description: 'The ID of the site.'
|
||||||
|
required: true
|
||||||
|
example: 14
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
site_id: 14
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
provider:
|
from:
|
||||||
name: provider
|
name: from
|
||||||
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)'
|
|
||||||
required: true
|
|
||||||
example: voluptatem
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the server provider.'
|
|
||||||
required: true
|
|
||||||
example: repellat
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
token:
|
|
||||||
name: token
|
|
||||||
description: 'The token if provider requires api token'
|
|
||||||
required: true
|
|
||||||
example: omnis
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
key:
|
|
||||||
name: key
|
|
||||||
description: 'The key if provider requires key'
|
|
||||||
required: true
|
|
||||||
example: recusandae
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
secret:
|
|
||||||
name: secret
|
|
||||||
description: 'The secret if provider requires key'
|
|
||||||
required: true
|
|
||||||
example: in
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
provider: voluptatem
|
|
||||||
name: repellat
|
|
||||||
token: omnis
|
|
||||||
key: recusandae
|
|
||||||
secret: in
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 8fbgDV6vdhakE1c64e3P5aZ'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: server-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
|
required: true
|
||||||
example: 1
|
example: architecto
|
||||||
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: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer eVE816Pc4ak3bdfahDZv6g5'
|
|
||||||
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: est
|
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
global:
|
to:
|
||||||
name: global
|
name: to
|
||||||
description: 'Accessible in all projects'
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: true
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
mode:
|
||||||
|
name: mode
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 307
|
||||||
type: string
|
type: string
|
||||||
enumValues:
|
enumValues:
|
||||||
- true
|
- 301
|
||||||
- false
|
- 302
|
||||||
|
- 307
|
||||||
|
- 308
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
name: est
|
from: architecto
|
||||||
global: true
|
to: architecto
|
||||||
|
mode: 307
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
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"}'
|
content: null
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer va86keaPDdh3b16Z54EgfcV'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -311,18 +112,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects/{redirect_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: server-providers
|
groupName: redirects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: ''
|
description: 'Delete a redirect.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -336,11 +136,31 @@ 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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
site_id:
|
||||||
|
name: site_id
|
||||||
|
description: 'The ID of the site.'
|
||||||
|
required: true
|
||||||
|
example: 14
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
redirect_id:
|
||||||
|
name: redirect_id
|
||||||
|
description: 'The ID of the redirect.'
|
||||||
|
required: true
|
||||||
|
example: 2
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -348,7 +168,9 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
serverProvider_id: 1
|
server_id: 6
|
||||||
|
site_id: 14
|
||||||
|
redirect_id: 2
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -362,10 +184,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer abv13ag8h5fZ4EPVDe6dc6k'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: ssh-keys
|
name: servers
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
|
uri: 'api/projects/{project_id}/servers'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: ssh-keys
|
groupName: servers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all ssh keys.'
|
description: 'Get all servers in a project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -31,19 +30,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,15 +40,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":7,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Rhiannon Hackett","ssh_user":"vito","ssh_users":["root","vito"],"ip":"15.21.182.27","local_ip":"15.126.47.30","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":8,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Maya Bins","ssh_user":"vito","ssh_users":["root","vito"],"ip":"88.63.32.129","local_ip":"161.58.4.234","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 1gEva8Z6e6abPDhk453fdVc'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -68,18 +53,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
|
uri: 'api/projects/{project_id}/servers'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: ssh-keys
|
groupName: servers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Deploy ssh key to server.'
|
description: 'Create a new server.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -93,27 +77,71 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
server_id:
|
cleanUrlParameters:
|
||||||
name: server_id
|
project_id: 1
|
||||||
description: 'The ID of the server.'
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
provider:
|
||||||
|
name: provider
|
||||||
|
description: 'The server provider type'
|
||||||
required: true
|
required: true
|
||||||
example: 8
|
example: architecto
|
||||||
type: integer
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
server_provider:
|
||||||
project_id: 1
|
name: server_provider
|
||||||
server_id: 8
|
description: 'If the provider is not custom, the ID of the server provider profile'
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
key_id:
|
|
||||||
name: key_id
|
|
||||||
description: 'The ID of the key.'
|
|
||||||
required: true
|
required: true
|
||||||
example: numquam
|
example: linode
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
plan:
|
||||||
|
name: plan
|
||||||
|
description: 'Provider plan if the provider is not custom'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
ip:
|
||||||
|
name: ip
|
||||||
|
description: 'SSH IP address if the provider is custom'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
port:
|
||||||
|
name: port
|
||||||
|
description: 'SSH Port if the provider is custom'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -121,60 +149,175 @@ 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.'
|
||||||
required: true
|
required: true
|
||||||
example: alias
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
public_key:
|
os:
|
||||||
name: public_key
|
name: os
|
||||||
description: 'Public Key, required if key_id is not provided.'
|
description: 'The os of the server'
|
||||||
required: true
|
required: true
|
||||||
example: voluptate
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
|
webserver:
|
||||||
|
name: webserver
|
||||||
|
description: 'Web server'
|
||||||
|
required: true
|
||||||
|
example: none
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- none
|
||||||
|
- nginx
|
||||||
|
- caddy
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
database:
|
||||||
|
name: database
|
||||||
|
description: Database
|
||||||
|
required: true
|
||||||
|
example: mysql80
|
||||||
|
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: '8.2'
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- '7.0'
|
||||||
|
- '7.1'
|
||||||
|
- '7.2'
|
||||||
|
- '7.3'
|
||||||
|
- '7.4'
|
||||||
|
- '8.0'
|
||||||
|
- '8.1'
|
||||||
|
- '8.2'
|
||||||
|
- '8.3'
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
key_id: numquam
|
provider: architecto
|
||||||
name: alias
|
server_provider: linode
|
||||||
public_key: voluptate
|
region: architecto
|
||||||
|
plan: architecto
|
||||||
|
ip: architecto
|
||||||
|
port: architecto
|
||||||
|
name: architecto
|
||||||
|
os: architecto
|
||||||
|
webserver: none
|
||||||
|
database: mysql80
|
||||||
|
php: '8.2'
|
||||||
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":7,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Ms. Elisabeth Okuneva","ssh_user":"vito","ssh_users":["root","vito"],"ip":"75.13.66.152","local_ip":"199.172.126.144","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer V64Z86fEdbavh1PgackDe53'
|
|
||||||
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}/servers/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: ssh-keys
|
groupName: servers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: show
|
||||||
description: 'Delete ssh key from server.'
|
description: 'Get a server by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":7,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Belle Dickens","ssh_user":"vito","ssh_users":["root","vito"],"ip":"51.210.32.30","local_ip":"82.174.132.158","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -192,17 +335,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: 6
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
sshKey_id:
|
|
||||||
name: sshKey_id
|
|
||||||
description: 'The ID of the sshKey.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -210,8 +343,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
sshKey_id: 1
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -225,10 +357,123 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer 3deg1vc65k8D6abahfZVPE4'
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: services
|
name: server-providers
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services'
|
uri: 'api/projects/{project_id}/server-providers'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all services.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -31,19 +30,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,15 +40,114 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":4,"project_id":null,"global":true,"name":"ab","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":5,"project_id":null,"global":true,"name":"incidunt","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer cdhb5VevgkZ6DafP6184a3E'
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/server-providers'
|
||||||
|
metadata:
|
||||||
|
groupName: server-providers
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the server provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
key:
|
||||||
|
name: key
|
||||||
|
description: 'The key if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
secret:
|
||||||
|
name: secret
|
||||||
|
description: 'The secret if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
provider: architecto
|
||||||
|
name: architecto
|
||||||
|
token: architecto
|
||||||
|
key: architecto
|
||||||
|
secret: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -68,18 +155,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}'
|
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a service by ID.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -93,21 +179,11 @@ 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
|
required: true
|
||||||
example: 8
|
example: 3
|
||||||
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,8 +191,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
serverProvider_id: 3
|
||||||
id: 53
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -125,34 +200,30 @@ endpoints:
|
|||||||
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":4,"project_id":null,"global":true,"name":"mollitia","provider":"vultr","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 3vDaE6Pc51Zg8kbheadVf64'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
custom: []
|
custom: []
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- PUT
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
|
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: start
|
title: update
|
||||||
description: 'Start service.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -166,21 +237,11 @@ 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
|
required: true
|
||||||
example: 8
|
example: 3
|
||||||
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
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -188,317 +249,45 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
serverProvider_id: 3
|
||||||
service_id: 53
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters:
|
||||||
cleanBodyParameters: []
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the server provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
global: false
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 204
|
status: 200
|
||||||
content: null
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
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,18 +295,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}'
|
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete service.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -531,21 +319,11 @@ 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
|
required: true
|
||||||
example: 8
|
example: 3
|
||||||
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
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -553,8 +331,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
serverProvider_id: 3
|
||||||
service_id: 53
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -568,10 +345,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer dcb68hg634P1DaZvef5VakE'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: sites
|
name: ssh-keys
|
||||||
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}/ssh-keys'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: sites
|
groupName: ssh-keys
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all sites.'
|
description: 'Get all ssh keys.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -35,7 +34,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -43,7 +42,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -52,15 +51,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":3,"name":"Haven Romaguera","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":4,"name":"Viva Marquardt","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 3gE54ahkea166PfvbVD8Zdc'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -68,18 +64,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites'
|
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: sites
|
groupName: ssh-keys
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new site.'
|
description: 'Deploy ssh key to server.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -97,7 +92,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -105,240 +100,54 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
type:
|
key_id:
|
||||||
name: type
|
name: key_id
|
||||||
description: ''
|
description: 'The ID of the key.'
|
||||||
required: true
|
required: true
|
||||||
example: php
|
example: architecto
|
||||||
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
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
aliases:
|
name:
|
||||||
name: aliases
|
name: name
|
||||||
description: ''
|
description: 'Key name, required if key_id is not provided.'
|
||||||
required: true
|
required: true
|
||||||
example:
|
example: architecto
|
||||||
- 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
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
web_directory:
|
public_key:
|
||||||
name: web_directory
|
name: public_key
|
||||||
description: 'Required for PHP and Laravel sites'
|
description: 'Public Key, required if key_id is not provided.'
|
||||||
required: true
|
required: true
|
||||||
example: public
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
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:
|
cleanBodyParameters:
|
||||||
type: php
|
key_id: architecto
|
||||||
domain: rem
|
name: architecto
|
||||||
aliases:
|
public_key: architecto
|
||||||
- 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: []
|
fileParameters: []
|
||||||
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":3,"name":"Ms. Elisabeth Okuneva","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer e1V4ga3Pavk6ch6b5E8fZdD'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{id}'
|
|
||||||
metadata:
|
|
||||||
groupName: sites
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: show
|
|
||||||
description: 'Get a site 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: []
|
|
||||||
server_id:
|
|
||||||
name: server_id
|
|
||||||
description: 'The ID of the server.'
|
|
||||||
required: true
|
|
||||||
example: 8
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the site.'
|
|
||||||
required: true
|
|
||||||
example: 26
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
id: 26
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
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 8gZkEaehfd4v3bac615DVP6'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -346,18 +155,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys/{sshKey_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: sites
|
groupName: ssh-keys
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete site.'
|
description: 'Delete ssh key from server.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -375,17 +183,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
site_id:
|
sshKey_id:
|
||||||
name: site_id
|
name: sshKey_id
|
||||||
description: 'The ID of the site.'
|
description: 'The ID of the sshKey.'
|
||||||
required: true
|
required: true
|
||||||
example: 26
|
example: 1
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -393,8 +201,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
site_id: 26
|
sshKey_id: 1
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -408,110 +216,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer aadb1h6f6kD4V8vePZgcE35'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/load-balancer'
|
|
||||||
metadata:
|
|
||||||
groupName: sites
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: load-balancer
|
|
||||||
description: 'Update load balancer.'
|
|
||||||
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: []
|
|
||||||
site_id:
|
|
||||||
name: site_id
|
|
||||||
description: 'The ID of the site.'
|
|
||||||
required: true
|
|
||||||
example: 26
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
site_id: 26
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
method:
|
|
||||||
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: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: null
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5E6hZa64bka1cV3Pdvf8Deg'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
name: source-controls
|
name: services
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/source-controls'
|
uri: 'api/projects/{project_id}/servers/{server_id}/services'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: source-controls
|
groupName: services
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: ''
|
description: 'Get all services.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -31,8 +30,19 @@ 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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -41,15 +51,81 @@ endpoints:
|
|||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
status: 200
|
||||||
content: '{"data":[{"id":5,"project_id":null,"global":true,"name":"Mr. Reuben Schimmel","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":6,"project_id":null,"global":true,"name":"Ms. Brandy Mraz V","provider":"github","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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":null,"server_id":1,"type":"webserver","type_data":null,"name":"nginx","version":null,"unit":null,"status":"ready","status_color":"success","icon":"","is_default":null,"created_at":null,"updated_at":null},{"id":null,"server_id":1,"type":"webserver","type_data":null,"name":"nginx","version":null,"unit":null,"status":"ready","status_color":"success","icon":"","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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer g4kDa1vV6cdfPe3baZ8h5E6'
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}'
|
||||||
|
metadata:
|
||||||
|
groupName: services
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: 'Get a service by ID.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
id:
|
||||||
|
name: id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":null,"server_id":1,"type":"webserver","type_data":null,"name":"nginx","version":null,"unit":null,"status":"ready","status_color":"success","icon":"","is_default":null,"created_at":null,"updated_at":null}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -57,18 +133,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/source-controls'
|
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: source-controls
|
groupName: services
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: start
|
||||||
description: ''
|
description: 'Start service.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -82,131 +157,21 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
server_id:
|
||||||
project_id: 1
|
name: server_id
|
||||||
queryParameters: []
|
description: 'The ID of the server.'
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
provider:
|
|
||||||
name: provider
|
|
||||||
description: 'The provider'
|
|
||||||
required: true
|
required: true
|
||||||
example: bitbucket
|
example: 6
|
||||||
type: string
|
|
||||||
enumValues:
|
|
||||||
- gitlab
|
|
||||||
- github
|
|
||||||
- bitbucket
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the storage provider.'
|
|
||||||
required: true
|
|
||||||
example: dignissimos
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
token:
|
|
||||||
name: token
|
|
||||||
description: 'The token if provider requires api token'
|
|
||||||
required: true
|
|
||||||
example: voluptates
|
|
||||||
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.hamill.net/culpa-non-qui-suscipit-dolores-id-aliquam'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
username:
|
|
||||||
name: username
|
|
||||||
description: 'The username if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: nisi
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
password:
|
|
||||||
name: password
|
|
||||||
description: 'The password if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: W~19Z0
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
provider: bitbucket
|
|
||||||
name: dignissimos
|
|
||||||
token: voluptates
|
|
||||||
url: 'https://www.hamill.net/culpa-non-qui-suscipit-dolores-id-aliquam'
|
|
||||||
username: nisi
|
|
||||||
password: W~19Z0
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":5,"project_id":null,"global":true,"name":"Harmony Koss DVM","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer fhEkg836V6cbd5ZPva4Dae1'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: source-controls
|
|
||||||
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
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
sourceControl_id:
|
service_id:
|
||||||
name: sourceControl_id
|
name: service_id
|
||||||
description: 'The ID of the sourceControl.'
|
description: 'The ID of the service.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 22
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -214,199 +179,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
sourceControl_id: 1
|
server_id: 6
|
||||||
queryParameters: []
|
service_id: 22
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":5,"project_id":null,"global":true,"name":"Martin Welch","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 458gPbv6deEfkcZ13ahaD6V'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- PUT
|
|
||||||
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: source-controls
|
|
||||||
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: []
|
|
||||||
sourceControl_id:
|
|
||||||
name: sourceControl_id
|
|
||||||
description: 'The ID of the sourceControl.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
sourceControl_id: 1
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the storage provider.'
|
|
||||||
required: true
|
|
||||||
example: aut
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
token:
|
|
||||||
name: token
|
|
||||||
description: 'The token if provider requires api token'
|
|
||||||
required: true
|
|
||||||
example: repudiandae
|
|
||||||
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: 'http://howe.net/eaque-assumenda-voluptatem-quo-libero-eius.html'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
username:
|
|
||||||
name: username
|
|
||||||
description: 'The username if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: consequatur
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
password:
|
|
||||||
name: password
|
|
||||||
description: 'The password if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: 'oX/H"pAIt7R2"'
|
|
||||||
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: aut
|
|
||||||
token: repudiandae
|
|
||||||
url: 'http://howe.net/eaque-assumenda-voluptatem-quo-libero-eius.html'
|
|
||||||
username: consequatur
|
|
||||||
password: 'oX/H"pAIt7R2"'
|
|
||||||
global: false
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":5,"project_id":null,"global":true,"name":"Miss Dulce Nicolas III","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer De1a4dEaV5v3Zgh8fPk66bc'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: source-controls
|
|
||||||
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: []
|
|
||||||
sourceControl_id:
|
|
||||||
name: sourceControl_id
|
|
||||||
description: 'The ID of the sourceControl.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
sourceControl_id: 1
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -420,10 +194,352 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer EZhd63eafgcV4a651PvkDb8'
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
File diff suppressed because it is too large
Load Diff
410
.scribe/endpoints.cache/13.yaml
Normal file
410
.scribe/endpoints.cache/13.yaml
Normal file
@ -0,0 +1,410 @@
|
|||||||
|
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||||
|
|
||||||
|
name: source-controls
|
||||||
|
description: ''
|
||||||
|
endpoints:
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/source-controls'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: list
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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":2,"project_id":null,"global":true,"name":"Ms. Elisabeth Okuneva","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":3,"project_id":null,"global":true,"name":"Aleen O''Kon","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/source-controls'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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'
|
||||||
|
required: true
|
||||||
|
example: gitlab
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- gitlab
|
||||||
|
- github
|
||||||
|
- bitbucket
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
username:
|
||||||
|
name: username
|
||||||
|
description: 'The username if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
password:
|
||||||
|
name: password
|
||||||
|
description: 'The password if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: '|]|{+-'
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
provider: gitlab
|
||||||
|
name: architecto
|
||||||
|
token: architecto
|
||||||
|
url: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
username: architecto
|
||||||
|
password: '|]|{+-'
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":2,"project_id":null,"global":true,"name":"Mrs. Justina Gaylord","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: []
|
||||||
|
sourceControl_id:
|
||||||
|
name: sourceControl_id
|
||||||
|
description: 'The ID of the sourceControl.'
|
||||||
|
required: true
|
||||||
|
example: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
sourceControl_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":2,"project_id":null,"global":true,"name":"Misael Runte","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- PUT
|
||||||
|
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: update
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: []
|
||||||
|
sourceControl_id:
|
||||||
|
name: sourceControl_id
|
||||||
|
description: 'The ID of the sourceControl.'
|
||||||
|
required: true
|
||||||
|
example: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
sourceControl_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
username:
|
||||||
|
name: username
|
||||||
|
description: 'The username if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
password:
|
||||||
|
name: password
|
||||||
|
description: 'The password if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: '|]|{+-'
|
||||||
|
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: architecto
|
||||||
|
token: architecto
|
||||||
|
url: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
username: architecto
|
||||||
|
password: '|]|{+-'
|
||||||
|
global: false
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":2,"project_id":null,"global":true,"name":"Mrs. Justina Gaylord","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: []
|
||||||
|
sourceControl_id:
|
||||||
|
name: sourceControl_id
|
||||||
|
description: 'The ID of the sourceControl.'
|
||||||
|
required: true
|
||||||
|
example: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
sourceControl_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
352
.scribe/endpoints.cache/14.yaml
Normal file
352
.scribe/endpoints.cache/14.yaml
Normal file
@ -0,0 +1,352 @@
|
|||||||
|
## 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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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":4,"project_id":null,"global":true,"name":"harum","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":5,"project_id":null,"global":true,"name":"commodi","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
key:
|
||||||
|
name: key
|
||||||
|
description: 'The key if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
secret:
|
||||||
|
name: secret
|
||||||
|
description: 'The secret if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
provider: architecto
|
||||||
|
name: architecto
|
||||||
|
token: architecto
|
||||||
|
key: architecto
|
||||||
|
secret: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
storageProvider_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"et","provider":"dropbox","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
storageProvider_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
global: true
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
storageProvider_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
@ -1,217 +1,158 @@
|
|||||||
name: cron-jobs
|
name: Endpoints
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
|
||||||
metadata:
|
|
||||||
groupName: cron-jobs
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: list
|
|
||||||
description: 'Get all cron jobs.'
|
|
||||||
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: 200
|
|
||||||
content: '{"data":[{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer ge6ZVa4kfD86hdv5a31EcbP'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
uri: 'api/servers/{server_id}/agent/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: cron-jobs
|
groupName: Endpoints
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: ''
|
||||||
description: 'Create a new cron job.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
project_id:
|
server_id:
|
||||||
name: project_id
|
name: server_id
|
||||||
description: 'The ID of the project.'
|
description: 'The ID of the server.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
server_id:
|
id:
|
||||||
name: server_id
|
name: id
|
||||||
description: 'The ID of the server.'
|
description: 'The ID of the agent.'
|
||||||
required: true
|
required: true
|
||||||
example: 8
|
example: architecto
|
||||||
type: integer
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
server_id: 6
|
||||||
server_id: 8
|
id: architecto
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
command:
|
load:
|
||||||
name: command
|
name: load
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: itaque
|
example: 4326.41688
|
||||||
type: string
|
type: number
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
user:
|
memory_total:
|
||||||
name: user
|
name: memory_total
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: root
|
example: 4326.41688
|
||||||
type: string
|
type: number
|
||||||
enumValues:
|
enumValues: []
|
||||||
- root
|
|
||||||
- vito
|
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
frequency:
|
memory_used:
|
||||||
name: frequency
|
name: memory_used
|
||||||
description: 'Frequency of the cron job.'
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: '* * * * *'
|
example: 4326.41688
|
||||||
type: string
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
memory_free:
|
||||||
|
name: memory_free
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
disk_total:
|
||||||
|
name: disk_total
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
disk_used:
|
||||||
|
name: disk_used
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
disk_free:
|
||||||
|
name: disk_free
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 4326.41688
|
||||||
|
type: number
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
command: itaque
|
load: 4326.41688
|
||||||
user: root
|
memory_total: 4326.41688
|
||||||
frequency: '* * * * *'
|
memory_used: 4326.41688
|
||||||
|
memory_free: 4326.41688
|
||||||
|
disk_total: 4326.41688
|
||||||
|
disk_used: 4326.41688
|
||||||
|
disk_free: 4326.41688
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses: []
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer cdh5bD8gVPkf34e1ZEva6a6'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
custom: []
|
custom: []
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
0: GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
2: POST
|
||||||
|
3: PUT
|
||||||
|
4: PATCH
|
||||||
|
5: DELETE
|
||||||
|
6: OPTIONS
|
||||||
|
uri: api/git-hooks
|
||||||
metadata:
|
metadata:
|
||||||
groupName: cron-jobs
|
groupName: Endpoints
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: ''
|
||||||
description: 'Get a cron job by ID.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters: []
|
||||||
project_id:
|
cleanUrlParameters: []
|
||||||
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: []
|
|
||||||
cronJob_id:
|
|
||||||
name: cronJob_id
|
|
||||||
description: 'The ID of the cronJob.'
|
|
||||||
required: true
|
|
||||||
example: 18
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
cronJob_id: 18
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -219,89 +160,21 @@ endpoints:
|
|||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
status: 404
|
||||||
content: '{"id":null,"server_id":null,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","created_at":null,"updated_at":null}'
|
content: |-
|
||||||
headers: []
|
{
|
||||||
description: ''
|
"message": ""
|
||||||
|
}
|
||||||
|
headers:
|
||||||
|
cache-control: 'no-cache, private'
|
||||||
|
content-type: application/json
|
||||||
|
x-ratelimit-limit: '60'
|
||||||
|
x-ratelimit-remaining: '57'
|
||||||
|
access-control-allow-origin: '*'
|
||||||
|
description: null
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer fa5VgdkaD8cZ6vh34Pb16eE'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: cron-jobs
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: delete
|
|
||||||
description: 'Delete cron job.'
|
|
||||||
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: []
|
|
||||||
cronJob_id:
|
|
||||||
name: cronJob_id
|
|
||||||
description: 'The ID of the cronJob.'
|
|
||||||
required: true
|
|
||||||
example: 10
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
cronJob_id: 10
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 204
|
|
||||||
content: null
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P8hkva3ZD4fgb166adEVce5'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: databases
|
name: cron-jobs
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all databases.'
|
description: 'Get all cron jobs.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -33,7 +32,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -41,7 +40,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -50,15 +49,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":3,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":4,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Z641ebPacDV6f38kEgdah5v'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -66,18 +62,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new database.'
|
description: 'Create a new cron job.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -95,7 +90,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -103,35 +98,56 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
name:
|
command:
|
||||||
name: name
|
name: command
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: et
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
user:
|
||||||
|
name: user
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: vito
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- root
|
||||||
|
- vito
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
frequency:
|
||||||
|
name: frequency
|
||||||
|
description: 'Frequency of the cron job.'
|
||||||
|
required: true
|
||||||
|
example: '* * * * *'
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
name: et
|
command: architecto
|
||||||
|
user: vito
|
||||||
|
frequency: '* * * * *'
|
||||||
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":3,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer d4gbv56caV3aZ8D1h6kfEPe'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -139,18 +155,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a database by ID.'
|
description: 'Get a cron job by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -168,17 +183,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
id:
|
cronJob_id:
|
||||||
name: id
|
name: cronJob_id
|
||||||
description: 'The ID of the database.'
|
description: 'The ID of the cronJob.'
|
||||||
required: true
|
required: true
|
||||||
example: 19
|
example: 1
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -186,8 +201,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
id: 19
|
cronJob_id: 1
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -196,15 +211,12 @@ 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":3,"server_id":1,"command":"ls -la","user":"root","frequency":"* * * * *","status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P68VgDcaEZvk63f4b5aed1h'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -212,18 +224,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{database_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/cron-jobs/{cronJob_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: databases
|
groupName: cron-jobs
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete database.'
|
description: 'Delete cron job.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -241,17 +252,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
database_id:
|
cronJob_id:
|
||||||
name: database_id
|
name: cronJob_id
|
||||||
description: 'The ID of the database.'
|
description: 'The ID of the cronJob.'
|
||||||
required: true
|
required: true
|
||||||
example: 15
|
example: 1
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -259,8 +270,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
database_id: 15
|
cronJob_id: 1
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -274,10 +285,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer DkPc6d1heEv5a8fb4V63agZ'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: database-users
|
name: databases
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: database-users
|
groupName: databases
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all database users.'
|
description: 'Get all databases.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -33,330 +32,6 @@ 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
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P4gD36fZeckvVh5ab86Ead1'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: create
|
|
||||||
description: 'Create a new database user.'
|
|
||||||
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:
|
|
||||||
username:
|
|
||||||
name: username
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: consequuntur
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
password:
|
|
||||||
name: password
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: 'fI/i2.O4u&dla?eXvR2'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
host:
|
|
||||||
name: host
|
|
||||||
description: 'Host, if it is a remote user.'
|
|
||||||
required: true
|
|
||||||
example: '%'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
username: consequuntur
|
|
||||||
password: 'fI/i2.O4u&dla?eXvR2'
|
|
||||||
host: '%'
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"username":"kari.farrell","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5k8Vced1baaE6f4ZvDPgh36'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: show
|
|
||||||
description: 'Get a database user 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: []
|
|
||||||
server_id:
|
|
||||||
name: server_id
|
|
||||||
description: 'The ID of the server.'
|
|
||||||
required: true
|
|
||||||
example: 8
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
databaseUser_id:
|
|
||||||
name: databaseUser_id
|
|
||||||
description: 'The ID of the databaseUser.'
|
|
||||||
required: true
|
|
||||||
example: 18
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
databaseUser_id: 18
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"username":"caterina.mosciski","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 3kDveP5V8a6dghfa4E16cbZ'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}/link'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: link
|
|
||||||
description: 'Link to databases'
|
|
||||||
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: []
|
|
||||||
databaseUser_id:
|
|
||||||
name: databaseUser_id
|
|
||||||
description: 'The ID of the databaseUser.'
|
|
||||||
required: true
|
|
||||||
example: 4
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
databaseUser_id: 4
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
databases:
|
|
||||||
name: databases
|
|
||||||
description: 'Array of database names to link to the user.'
|
|
||||||
required: true
|
|
||||||
example: non
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
databases: non
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":null,"server_id":null,"username":"kurtis05","databases":[],"host":"%","status":null,"created_at":null,"updated_at":null}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer DgPea43EvV51a866dfbZckh'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: database-users
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: delete
|
|
||||||
description: 'Delete database user.'
|
|
||||||
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: []
|
|
||||||
databaseUser_id:
|
|
||||||
name: databaseUser_id
|
|
||||||
description: 'The ID of the databaseUser.'
|
|
||||||
required: true
|
|
||||||
example: 6
|
example: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
@ -365,8 +40,236 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
databaseUser_id: 6
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"data":[{"id":9,"server_id":1,"name":"zbailey","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":10,"server_id":1,"name":"rempel.chadrick","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
||||||
|
metadata:
|
||||||
|
groupName: databases
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: 'Create a new database.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
charset:
|
||||||
|
name: charset
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
collation:
|
||||||
|
name: collation
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
name: architecto
|
||||||
|
charset: architecto
|
||||||
|
collation: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":9,"server_id":1,"name":"zbailey","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{id}'
|
||||||
|
metadata:
|
||||||
|
groupName: databases
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: 'Get a database by ID.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
id:
|
||||||
|
name: id
|
||||||
|
description: 'The ID of the database.'
|
||||||
|
required: true
|
||||||
|
example: 8
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
id: 8
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":9,"server_id":1,"name":"rempel.chadrick","collation":null,"charset":null,"status":"ready","status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{database_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: databases
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: 'Delete database.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
database_id:
|
||||||
|
name: database_id
|
||||||
|
description: 'The ID of the database.'
|
||||||
|
required: true
|
||||||
|
example: 8
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
database_id: 8
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -380,10 +283,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 6ackVP8hEZd3164gD5evafb'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: firewall-rules
|
name: database-users
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all firewall rules.'
|
description: 'Get all database users.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -33,7 +32,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -41,7 +40,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -50,15 +49,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":4,"server_id":1,"username":"cartwright.maxine","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":5,"server_id":1,"username":"gusikowski.eden","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer h3P5gD8E4dkeZ6abac6vfV1'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -66,18 +62,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new firewall rule.'
|
description: 'Create a new database user.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -95,7 +90,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -103,83 +98,54 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
type:
|
username:
|
||||||
name: type
|
name: username
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: deny
|
example: architecto
|
||||||
type: string
|
|
||||||
enumValues:
|
|
||||||
- allow
|
|
||||||
- deny
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
protocol:
|
|
||||||
name: protocol
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: udp
|
|
||||||
type: string
|
|
||||||
enumValues:
|
|
||||||
- tcp
|
|
||||||
- udp
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
port:
|
|
||||||
name: port
|
|
||||||
description: ''
|
|
||||||
required: true
|
|
||||||
example: et
|
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
source:
|
password:
|
||||||
name: source
|
name: password
|
||||||
description: ''
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: voluptates
|
example: '|]|{+-'
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
mask:
|
host:
|
||||||
name: mask
|
name: host
|
||||||
description: 'Mask for source IP.'
|
description: 'Host, if it is a remote user.'
|
||||||
required: true
|
required: true
|
||||||
example: '0'
|
example: '%'
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
type: deny
|
username: architecto
|
||||||
protocol: udp
|
password: '|]|{+-'
|
||||||
port: et
|
host: '%'
|
||||||
source: voluptates
|
|
||||||
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":4,"server_id":1,"username":"justina.gaylord","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 6a8DVv5k3gZfEe6hb1daPc4'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -187,18 +153,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a firewall rule by ID.'
|
description: 'Get a database user by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -216,17 +181,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
firewallRule_id:
|
databaseUser_id:
|
||||||
name: firewallRule_id
|
name: databaseUser_id
|
||||||
description: 'The ID of the firewallRule.'
|
description: 'The ID of the databaseUser.'
|
||||||
required: true
|
required: true
|
||||||
example: 29
|
example: 16
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -234,8 +199,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
firewallRule_id: 29
|
databaseUser_id: 16
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -244,34 +209,30 @@ 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":4,"server_id":1,"username":"zbailey","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer P4bZdV1geED3kfh568aa6cv'
|
|
||||||
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}/firewall-rules/{firewallRule_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}/link'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: firewall-rules
|
groupName: database-users
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: link
|
||||||
description: 'Delete firewall rule.'
|
description: 'Link to databases'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -289,17 +250,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
firewallRule_id:
|
databaseUser_id:
|
||||||
name: firewallRule_id
|
name: databaseUser_id
|
||||||
description: 'The ID of the firewallRule.'
|
description: 'The ID of the databaseUser.'
|
||||||
required: true
|
required: true
|
||||||
example: 29
|
example: 16
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -307,8 +268,88 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
firewallRule_id: 29
|
databaseUser_id: 16
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
databases:
|
||||||
|
name: databases
|
||||||
|
description: 'Array of database names to link to the user.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
databases: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"server_id":1,"username":"zbailey","databases":[],"host":"%","status":"creating","status_color":"warning","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/database-users/{databaseUser_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: database-users
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: 'Delete database user.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
databaseUser_id:
|
||||||
|
name: databaseUser_id
|
||||||
|
description: 'The ID of the databaseUser.'
|
||||||
|
required: true
|
||||||
|
example: 16
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
databaseUser_id: 16
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -322,10 +363,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Dh3kcaafdg6E5ZvV46ePb81'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,24 +1,46 @@
|
|||||||
name: general
|
name: firewall-rules
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: api/health
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: general
|
groupName: firewall-rules
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: health-check
|
title: list
|
||||||
description: ''
|
description: 'Get all firewall rules.'
|
||||||
authenticated: false
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters: []
|
urlParameters:
|
||||||
cleanUrlParameters: []
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -27,14 +49,414 @@ endpoints:
|
|||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
status: 200
|
||||||
content: '{"success":true,"version":"2.1.0"}'
|
content: '{"data":[{"id":22,"name":"eius","server_id":1,"type":"allow","protocol":"tcp","port":9322,"source":"113.14.236.204","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":23,"name":"velit","server_id":1,"type":"allow","protocol":"tcp","port":2983,"source":"199.172.126.144","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers:
|
headers: []
|
||||||
cache-control: 'no-cache, private'
|
description: ''
|
||||||
content-type: application/json
|
custom: []
|
||||||
x-ratelimit-limit: '60'
|
responseFields: []
|
||||||
x-ratelimit-remaining: '59'
|
auth: []
|
||||||
access-control-allow-origin: '*'
|
controller: null
|
||||||
description: null
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules'
|
||||||
|
metadata:
|
||||||
|
groupName: firewall-rules
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: 'Create a new firewall rule.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
source:
|
||||||
|
name: source
|
||||||
|
description: ''
|
||||||
|
required: false
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
type: allow
|
||||||
|
protocol: tcp
|
||||||
|
port: architecto
|
||||||
|
source: architecto
|
||||||
|
mask: '0'
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":22,"name":"eius","server_id":1,"type":"allow","protocol":"tcp","port":9322,"source":"113.14.236.204","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
firewallRule_id:
|
||||||
|
name: firewallRule_id
|
||||||
|
description: 'The ID of the firewallRule.'
|
||||||
|
required: true
|
||||||
|
example: 19
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
firewallRule_id: 19
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
type:
|
||||||
|
name: type
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: deny
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- allow
|
||||||
|
- deny
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
protocol:
|
||||||
|
name: protocol
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: udp
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- tcp
|
||||||
|
- udp
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
port:
|
||||||
|
name: port
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
source:
|
||||||
|
name: source
|
||||||
|
description: ''
|
||||||
|
required: false
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
type: deny
|
||||||
|
protocol: udp
|
||||||
|
port: architecto
|
||||||
|
source: architecto
|
||||||
|
mask: '0'
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":22,"name":"eius","server_id":1,"type":"allow","protocol":"tcp","port":9322,"source":"113.14.236.204","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: firewall-rules
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: 'Get a firewall rule by ID.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
firewallRule_id:
|
||||||
|
name: firewallRule_id
|
||||||
|
description: 'The ID of the firewallRule.'
|
||||||
|
required: true
|
||||||
|
example: 19
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
firewallRule_id: 19
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":22,"name":"velit","server_id":1,"type":"allow","protocol":"tcp","port":2983,"source":"199.172.126.144","mask":"24","note":"test","status":"creating","status_color":"info","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/firewall-rules/{firewallRule_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: firewall-rules
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: 'Delete firewall rule.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
firewallRule_id:
|
||||||
|
name: firewallRule_id
|
||||||
|
description: 'The ID of the firewallRule.'
|
||||||
|
required: true
|
||||||
|
example: 19
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
firewallRule_id: 19
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth: []
|
auth: []
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: projects
|
name: general
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: api/projects
|
uri: api/health
|
||||||
metadata:
|
metadata:
|
||||||
groupName: projects
|
groupName: general
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: health-check
|
||||||
description: 'Get all projects.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters: []
|
urlParameters: []
|
||||||
@ -28,230 +27,17 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"success":true,"version":"2.5.0"}'
|
||||||
headers: []
|
headers:
|
||||||
description: ''
|
cache-control: 'no-cache, private'
|
||||||
|
content-type: application/json
|
||||||
|
x-ratelimit-limit: '60'
|
||||||
|
x-ratelimit-remaining: '56'
|
||||||
|
access-control-allow-origin: '*'
|
||||||
|
description: null
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5DaveP3d6b6khEZVcg4fa18'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: api/projects
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: create
|
|
||||||
description: 'Create a new project.'
|
|
||||||
authenticated: true
|
|
||||||
custom: []
|
|
||||||
headers:
|
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
|
||||||
Accept: application/json
|
|
||||||
urlParameters: []
|
|
||||||
cleanUrlParameters: []
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the project.'
|
|
||||||
required: true
|
|
||||||
example: quos
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
name: quos
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":3,"name":"Isidro Franecki","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer a6P53EvkcZV6D4ghad1efb8'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{id}'
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: show
|
|
||||||
description: 'Get a project by ID.'
|
|
||||||
authenticated: true
|
|
||||||
custom: []
|
|
||||||
headers:
|
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
|
||||||
Accept: application/json
|
|
||||||
urlParameters:
|
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the project.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
id: 1
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":3,"name":"Rhoda Parisian","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer v48Ve5ZghdcbE1akP66fD3a'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- PUT
|
|
||||||
uri: 'api/projects/{id}'
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: update
|
|
||||||
description: 'Update project.'
|
|
||||||
authenticated: true
|
|
||||||
custom: []
|
|
||||||
headers:
|
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
|
||||||
Accept: application/json
|
|
||||||
urlParameters:
|
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the project.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
id: 1
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the project.'
|
|
||||||
required: true
|
|
||||||
example: ullam
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
name: ullam
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer fvEdh3Vgbk56Z4a61eP8caD'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: projects
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: delete
|
|
||||||
description: 'Delete project.'
|
|
||||||
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: 204
|
|
||||||
content: null
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer eg4c3vZ1Dhaa68d6PEfk5bV'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,36 +1,24 @@
|
|||||||
name: servers
|
name: projects
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers'
|
uri: api/projects
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all servers in a project.'
|
description: 'Get all projects.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters: []
|
||||||
project_id:
|
cleanUrlParameters: []
|
||||||
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: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -39,15 +27,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":3,"name":"Belle Dickens","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":4,"name":"Mittie Considine","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer E81avahec6365dbZfgD4kPV'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -55,198 +40,46 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers'
|
uri: api/projects
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new server.'
|
description: 'Create a new project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters: []
|
||||||
project_id:
|
cleanUrlParameters: []
|
||||||
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: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
provider:
|
|
||||||
name: provider
|
|
||||||
description: 'The server provider type'
|
|
||||||
required: true
|
|
||||||
example: iste
|
|
||||||
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: custom
|
|
||||||
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: 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: name
|
name: name
|
||||||
description: 'The name of the server.'
|
description: 'The name of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: illum
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
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
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
provider: iste
|
name: architecto
|
||||||
server_provider: custom
|
|
||||||
region: libero
|
|
||||||
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}'
|
content: '{"id":3,"name":"Ms. Elisabeth Okuneva","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer aad3Pvc4e65DghZVEk8f1b6'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -254,23 +87,22 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{id}'
|
uri: 'api/projects/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a server by ID.'
|
description: 'Get a project by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
project_id:
|
id:
|
||||||
name: project_id
|
name: id
|
||||||
description: 'The ID of the project.'
|
description: 'The ID of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 1
|
||||||
@ -279,19 +111,8 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the server.'
|
|
||||||
required: true
|
|
||||||
example: 8
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
id: 1
|
||||||
id: 8
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -300,39 +121,35 @@ endpoints:
|
|||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
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}'
|
content: '{"id":3,"name":"Aleen O''Kon","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5EhD3v6Z8Vdakfg46eP1cab'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
custom: []
|
custom: []
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- PUT
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/reboot'
|
uri: 'api/projects/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: reboot
|
title: update
|
||||||
description: 'Reboot a server.'
|
description: 'Update project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
project_id:
|
id:
|
||||||
name: project_id
|
name: id
|
||||||
description: 'The ID of the project.'
|
description: 'The ID of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 1
|
||||||
@ -341,98 +158,33 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
server_id:
|
cleanUrlParameters:
|
||||||
name: server_id
|
id: 1
|
||||||
description: 'The ID of the server.'
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the project.'
|
||||||
required: true
|
required: true
|
||||||
example: 8
|
example: architecto
|
||||||
type: integer
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanBodyParameters:
|
||||||
project_id: 1
|
name: architecto
|
||||||
server_id: 8
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 204
|
status: 200
|
||||||
content: null
|
content: '{"id":3,"name":"Ms. Elisabeth Okuneva","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Pc5Da6Vhdk1vag6fE84e3Zb'
|
|
||||||
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,18 +192,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}'
|
uri: 'api/projects/{project_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: servers
|
groupName: projects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete server.'
|
description: 'Delete project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -465,19 +216,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: []
|
||||||
@ -491,10 +231,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer haE8D6Z6gePk1vadVb53c4f'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,72 +1,20 @@
|
|||||||
name: server-providers
|
name: redirects
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/server-providers'
|
|
||||||
metadata:
|
|
||||||
groupName: server-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":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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer Df16eda8Pa345EkgbZ6cvhV'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/server-providers'
|
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: server-providers
|
groupName: redirects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: ''
|
description: 'Create a new redirect.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -80,228 +28,81 @@ 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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
site_id:
|
||||||
|
name: site_id
|
||||||
|
description: 'The ID of the site.'
|
||||||
|
required: true
|
||||||
|
example: 14
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
site_id: 14
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
provider:
|
from:
|
||||||
name: provider
|
name: from
|
||||||
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)'
|
|
||||||
required: true
|
|
||||||
example: voluptatem
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the server provider.'
|
|
||||||
required: true
|
|
||||||
example: repellat
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
token:
|
|
||||||
name: token
|
|
||||||
description: 'The token if provider requires api token'
|
|
||||||
required: true
|
|
||||||
example: omnis
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
key:
|
|
||||||
name: key
|
|
||||||
description: 'The key if provider requires key'
|
|
||||||
required: true
|
|
||||||
example: recusandae
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
secret:
|
|
||||||
name: secret
|
|
||||||
description: 'The secret if provider requires key'
|
|
||||||
required: true
|
|
||||||
example: in
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
provider: voluptatem
|
|
||||||
name: repellat
|
|
||||||
token: omnis
|
|
||||||
key: recusandae
|
|
||||||
secret: in
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 8fbgDV6vdhakE1c64e3P5aZ'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: server-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
|
required: true
|
||||||
example: 1
|
example: architecto
|
||||||
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: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
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"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer eVE816Pc4ak3bdfahDZv6g5'
|
|
||||||
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: est
|
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
global:
|
to:
|
||||||
name: global
|
name: to
|
||||||
description: 'Accessible in all projects'
|
description: ''
|
||||||
required: true
|
required: true
|
||||||
example: true
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
mode:
|
||||||
|
name: mode
|
||||||
|
description: ''
|
||||||
|
required: true
|
||||||
|
example: 307
|
||||||
type: string
|
type: string
|
||||||
enumValues:
|
enumValues:
|
||||||
- true
|
- 301
|
||||||
- false
|
- 302
|
||||||
|
- 307
|
||||||
|
- 308
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
name: est
|
from: architecto
|
||||||
global: true
|
to: architecto
|
||||||
|
mode: 307
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
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"}'
|
content: null
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer va86keaPDdh3b16Z54EgfcV'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -309,18 +110,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects/{redirect_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: server-providers
|
groupName: redirects
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: ''
|
description: 'Delete a redirect.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -334,11 +134,31 @@ 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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
site_id:
|
||||||
|
name: site_id
|
||||||
|
description: 'The ID of the site.'
|
||||||
|
required: true
|
||||||
|
example: 14
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
redirect_id:
|
||||||
|
name: redirect_id
|
||||||
|
description: 'The ID of the redirect.'
|
||||||
|
required: true
|
||||||
|
example: 2
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -346,7 +166,9 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
serverProvider_id: 1
|
server_id: 6
|
||||||
|
site_id: 14
|
||||||
|
redirect_id: 2
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -360,10 +182,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer abv13ag8h5fZ4EPVDe6dc6k'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: ssh-keys
|
name: servers
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
|
uri: 'api/projects/{project_id}/servers'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: ssh-keys
|
groupName: servers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all ssh keys.'
|
description: 'Get all servers in a project.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -29,19 +28,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,15 +38,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":7,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Rhiannon Hackett","ssh_user":"vito","ssh_users":["root","vito"],"ip":"15.21.182.27","local_ip":"15.126.47.30","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":8,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Maya Bins","ssh_user":"vito","ssh_users":["root","vito"],"ip":"88.63.32.129","local_ip":"161.58.4.234","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 1gEva8Z6e6abPDhk453fdVc'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -66,18 +51,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
|
uri: 'api/projects/{project_id}/servers'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: ssh-keys
|
groupName: servers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Deploy ssh key to server.'
|
description: 'Create a new server.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -91,27 +75,71 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
server_id:
|
cleanUrlParameters:
|
||||||
name: server_id
|
project_id: 1
|
||||||
description: 'The ID of the server.'
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
provider:
|
||||||
|
name: provider
|
||||||
|
description: 'The server provider type'
|
||||||
required: true
|
required: true
|
||||||
example: 8
|
example: architecto
|
||||||
type: integer
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
server_provider:
|
||||||
project_id: 1
|
name: server_provider
|
||||||
server_id: 8
|
description: 'If the provider is not custom, the ID of the server provider profile'
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
key_id:
|
|
||||||
name: key_id
|
|
||||||
description: 'The ID of the key.'
|
|
||||||
required: true
|
required: true
|
||||||
example: numquam
|
example: linode
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
plan:
|
||||||
|
name: plan
|
||||||
|
description: 'Provider plan if the provider is not custom'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
ip:
|
||||||
|
name: ip
|
||||||
|
description: 'SSH IP address if the provider is custom'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
port:
|
||||||
|
name: port
|
||||||
|
description: 'SSH Port if the provider is custom'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -119,60 +147,175 @@ 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.'
|
||||||
required: true
|
required: true
|
||||||
example: alias
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
public_key:
|
os:
|
||||||
name: public_key
|
name: os
|
||||||
description: 'Public Key, required if key_id is not provided.'
|
description: 'The os of the server'
|
||||||
required: true
|
required: true
|
||||||
example: voluptate
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
|
webserver:
|
||||||
|
name: webserver
|
||||||
|
description: 'Web server'
|
||||||
|
required: true
|
||||||
|
example: none
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- none
|
||||||
|
- nginx
|
||||||
|
- caddy
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
database:
|
||||||
|
name: database
|
||||||
|
description: Database
|
||||||
|
required: true
|
||||||
|
example: mysql80
|
||||||
|
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: '8.2'
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- '7.0'
|
||||||
|
- '7.1'
|
||||||
|
- '7.2'
|
||||||
|
- '7.3'
|
||||||
|
- '7.4'
|
||||||
|
- '8.0'
|
||||||
|
- '8.1'
|
||||||
|
- '8.2'
|
||||||
|
- '8.3'
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
cleanBodyParameters:
|
cleanBodyParameters:
|
||||||
key_id: numquam
|
provider: architecto
|
||||||
name: alias
|
server_provider: linode
|
||||||
public_key: voluptate
|
region: architecto
|
||||||
|
plan: architecto
|
||||||
|
ip: architecto
|
||||||
|
port: architecto
|
||||||
|
name: architecto
|
||||||
|
os: architecto
|
||||||
|
webserver: none
|
||||||
|
database: mysql80
|
||||||
|
php: '8.2'
|
||||||
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":7,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Ms. Elisabeth Okuneva","ssh_user":"vito","ssh_users":["root","vito"],"ip":"75.13.66.152","local_ip":"199.172.126.144","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer V64Z86fEdbavh1PgackDe53'
|
|
||||||
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}/servers/{id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: ssh-keys
|
groupName: servers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: show
|
||||||
description: 'Delete ssh key from server.'
|
description: 'Get a server by ID.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":7,"project_id":1,"services":[],"user_id":1,"provider_id":null,"name":"Belle Dickens","ssh_user":"vito","ssh_users":["root","vito"],"ip":"51.210.32.30","local_ip":"82.174.132.158","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":0,"last_update_check":null,"status_color":"success","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -190,17 +333,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: 6
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
sshKey_id:
|
|
||||||
name: sshKey_id
|
|
||||||
description: 'The ID of the sshKey.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -208,8 +341,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
sshKey_id: 1
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -223,10 +355,123 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer 3deg1vc65k8D6abahfZVPE4'
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: services
|
name: server-providers
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services'
|
uri: 'api/projects/{project_id}/server-providers'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all services.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -29,19 +28,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,15 +38,114 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":4,"project_id":null,"global":true,"name":"ab","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":5,"project_id":null,"global":true,"name":"incidunt","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer cdhb5VevgkZ6DafP6184a3E'
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/server-providers'
|
||||||
|
metadata:
|
||||||
|
groupName: server-providers
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the server provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
key:
|
||||||
|
name: key
|
||||||
|
description: 'The key if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
secret:
|
||||||
|
name: secret
|
||||||
|
description: 'The secret if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
provider: architecto
|
||||||
|
name: architecto
|
||||||
|
token: architecto
|
||||||
|
key: architecto
|
||||||
|
secret: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -66,18 +153,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}'
|
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: show
|
title: show
|
||||||
description: 'Get a service by ID.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -91,21 +177,11 @@ 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
|
required: true
|
||||||
example: 8
|
example: 3
|
||||||
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,8 +189,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
serverProvider_id: 3
|
||||||
id: 53
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -123,34 +198,30 @@ endpoints:
|
|||||||
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":4,"project_id":null,"global":true,"name":"mollitia","provider":"vultr","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 3vDaE6Pc51Zg8kbheadVf64'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
custom: []
|
custom: []
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- PUT
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
|
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: start
|
title: update
|
||||||
description: 'Start service.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -164,21 +235,11 @@ 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
|
required: true
|
||||||
example: 8
|
example: 3
|
||||||
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
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -186,317 +247,45 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
serverProvider_id: 3
|
||||||
service_id: 53
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters:
|
||||||
cleanBodyParameters: []
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the server provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
global: false
|
||||||
fileParameters: []
|
fileParameters: []
|
||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 204
|
status: 200
|
||||||
content: null
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"custom","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
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,18 +293,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}'
|
uri: 'api/projects/{project_id}/server-providers/{serverProvider_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: services
|
groupName: server-providers
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete service.'
|
description: ''
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -529,21 +317,11 @@ 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
|
required: true
|
||||||
example: 8
|
example: 3
|
||||||
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
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -551,8 +329,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
serverProvider_id: 3
|
||||||
service_id: 53
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -566,10 +343,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer dcb68hg634P1DaZvef5VakE'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: sites
|
name: ssh-keys
|
||||||
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}/ssh-keys'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: sites
|
groupName: ssh-keys
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: 'Get all sites.'
|
description: 'Get all ssh keys.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -33,7 +32,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -41,7 +40,7 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -50,15 +49,12 @@ 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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":3,"name":"Haven Romaguera","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":4,"name":"Viva Marquardt","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 3gE54ahkea166PfvbVD8Zdc'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -66,18 +62,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites'
|
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: sites
|
groupName: ssh-keys
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: create
|
||||||
description: 'Create a new site.'
|
description: 'Deploy ssh key to server.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -95,7 +90,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -103,240 +98,54 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters:
|
bodyParameters:
|
||||||
type:
|
key_id:
|
||||||
name: type
|
name: key_id
|
||||||
description: ''
|
description: 'The ID of the key.'
|
||||||
required: true
|
required: true
|
||||||
example: php
|
example: architecto
|
||||||
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
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
aliases:
|
name:
|
||||||
name: aliases
|
name: name
|
||||||
description: ''
|
description: 'Key name, required if key_id is not provided.'
|
||||||
required: true
|
required: true
|
||||||
example:
|
example: architecto
|
||||||
- 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
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
web_directory:
|
public_key:
|
||||||
name: web_directory
|
name: public_key
|
||||||
description: 'Required for PHP and Laravel sites'
|
description: 'Public Key, required if key_id is not provided.'
|
||||||
required: true
|
required: true
|
||||||
example: public
|
example: architecto
|
||||||
type: string
|
type: string
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
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:
|
cleanBodyParameters:
|
||||||
type: php
|
key_id: architecto
|
||||||
domain: rem
|
name: architecto
|
||||||
aliases:
|
public_key: architecto
|
||||||
- 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: []
|
fileParameters: []
|
||||||
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":3,"name":"Ms. Elisabeth Okuneva","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer e1V4ga3Pavk6ch6b5E8fZdD'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{id}'
|
|
||||||
metadata:
|
|
||||||
groupName: sites
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: show
|
|
||||||
description: 'Get a site 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: []
|
|
||||||
server_id:
|
|
||||||
name: server_id
|
|
||||||
description: 'The ID of the server.'
|
|
||||||
required: true
|
|
||||||
example: 8
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
id:
|
|
||||||
name: id
|
|
||||||
description: 'The ID of the site.'
|
|
||||||
required: true
|
|
||||||
example: 26
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
id: 26
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
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 8gZkEaehfd4v3bac615DVP6'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -344,18 +153,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- DELETE
|
- DELETE
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}'
|
uri: 'api/projects/{project_id}/servers/{server_id}/ssh-keys/{sshKey_id}'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: sites
|
groupName: ssh-keys
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: delete
|
title: delete
|
||||||
description: 'Delete site.'
|
description: 'Delete ssh key from server.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -373,17 +181,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: 6
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
site_id:
|
sshKey_id:
|
||||||
name: site_id
|
name: sshKey_id
|
||||||
description: 'The ID of the site.'
|
description: 'The ID of the sshKey.'
|
||||||
required: true
|
required: true
|
||||||
example: 26
|
example: 1
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -391,8 +199,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
server_id: 8
|
server_id: 6
|
||||||
site_id: 26
|
sshKey_id: 1
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -406,110 +214,7 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer aadb1h6f6kD4V8vePZgcE35'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- POST
|
|
||||||
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/load-balancer'
|
|
||||||
metadata:
|
|
||||||
groupName: sites
|
|
||||||
groupDescription: ''
|
|
||||||
subgroup: ''
|
|
||||||
subgroupDescription: ''
|
|
||||||
title: load-balancer
|
|
||||||
description: 'Update load balancer.'
|
|
||||||
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: []
|
|
||||||
site_id:
|
|
||||||
name: site_id
|
|
||||||
description: 'The ID of the site.'
|
|
||||||
required: true
|
|
||||||
example: 26
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
server_id: 8
|
|
||||||
site_id: 26
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
method:
|
|
||||||
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: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: null
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 5E6hZa64bka1cV3Pdvf8Deg'
|
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
@ -1,21 +1,20 @@
|
|||||||
name: source-controls
|
name: services
|
||||||
description: ''
|
description: ''
|
||||||
endpoints:
|
endpoints:
|
||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- GET
|
- GET
|
||||||
uri: 'api/projects/{project_id}/source-controls'
|
uri: 'api/projects/{project_id}/servers/{server_id}/services'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: source-controls
|
groupName: services
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: list
|
title: list
|
||||||
description: ''
|
description: 'Get all services.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -29,8 +28,19 @@ 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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -39,15 +49,81 @@ endpoints:
|
|||||||
responses:
|
responses:
|
||||||
-
|
-
|
||||||
status: 200
|
status: 200
|
||||||
content: '{"data":[{"id":5,"project_id":null,"global":true,"name":"Mr. Reuben Schimmel","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"},{"id":6,"project_id":null,"global":true,"name":"Ms. Brandy Mraz V","provider":"github","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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
content: '{"data":[{"id":null,"server_id":1,"type":"webserver","type_data":null,"name":"nginx","version":null,"unit":null,"status":"ready","status_color":"success","icon":"","is_default":null,"created_at":null,"updated_at":null},{"id":null,"server_id":1,"type":"webserver","type_data":null,"name":"nginx","version":null,"unit":null,"status":"ready","status_color":"success","icon":"","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":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
headers: []
|
headers: []
|
||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer g4kDa1vV6cdfPe3baZ8h5E6'
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/servers/{server_id}/services/{id}'
|
||||||
|
metadata:
|
||||||
|
groupName: services
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: 'Get a service by ID.'
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
id:
|
||||||
|
name: id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":null,"server_id":1,"type":"webserver","type_data":null,"name":"nginx","version":null,"unit":null,"status":"ready","status_color":"success","icon":"","is_default":null,"created_at":null,"updated_at":null}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
@ -55,18 +131,17 @@ endpoints:
|
|||||||
-
|
-
|
||||||
httpMethods:
|
httpMethods:
|
||||||
- POST
|
- POST
|
||||||
uri: 'api/projects/{project_id}/source-controls'
|
uri: 'api/projects/{project_id}/servers/{server_id}/services/{service_id}/start'
|
||||||
metadata:
|
metadata:
|
||||||
groupName: source-controls
|
groupName: services
|
||||||
groupDescription: ''
|
groupDescription: ''
|
||||||
subgroup: ''
|
subgroup: ''
|
||||||
subgroupDescription: ''
|
subgroupDescription: ''
|
||||||
title: create
|
title: start
|
||||||
description: ''
|
description: 'Start service.'
|
||||||
authenticated: true
|
authenticated: false
|
||||||
custom: []
|
custom: []
|
||||||
headers:
|
headers:
|
||||||
Authorization: 'Bearer YOUR-API-KEY'
|
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
urlParameters:
|
urlParameters:
|
||||||
@ -80,131 +155,21 @@ endpoints:
|
|||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
server_id:
|
||||||
project_id: 1
|
name: server_id
|
||||||
queryParameters: []
|
description: 'The ID of the server.'
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
provider:
|
|
||||||
name: provider
|
|
||||||
description: 'The provider'
|
|
||||||
required: true
|
required: true
|
||||||
example: bitbucket
|
example: 6
|
||||||
type: string
|
|
||||||
enumValues:
|
|
||||||
- gitlab
|
|
||||||
- github
|
|
||||||
- bitbucket
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the storage provider.'
|
|
||||||
required: true
|
|
||||||
example: dignissimos
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
token:
|
|
||||||
name: token
|
|
||||||
description: 'The token if provider requires api token'
|
|
||||||
required: true
|
|
||||||
example: voluptates
|
|
||||||
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.hamill.net/culpa-non-qui-suscipit-dolores-id-aliquam'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
username:
|
|
||||||
name: username
|
|
||||||
description: 'The username if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: nisi
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
password:
|
|
||||||
name: password
|
|
||||||
description: 'The password if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: W~19Z0
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanBodyParameters:
|
|
||||||
provider: bitbucket
|
|
||||||
name: dignissimos
|
|
||||||
token: voluptates
|
|
||||||
url: 'https://www.hamill.net/culpa-non-qui-suscipit-dolores-id-aliquam'
|
|
||||||
username: nisi
|
|
||||||
password: W~19Z0
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":5,"project_id":null,"global":true,"name":"Harmony Koss DVM","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer fhEkg836V6cbd5ZPva4Dae1'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- GET
|
|
||||||
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: source-controls
|
|
||||||
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
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
nullable: false
|
nullable: false
|
||||||
custom: []
|
custom: []
|
||||||
sourceControl_id:
|
service_id:
|
||||||
name: sourceControl_id
|
name: service_id
|
||||||
description: 'The ID of the sourceControl.'
|
description: 'The ID of the service.'
|
||||||
required: true
|
required: true
|
||||||
example: 1
|
example: 22
|
||||||
type: integer
|
type: integer
|
||||||
enumValues: []
|
enumValues: []
|
||||||
exampleWasSpecified: false
|
exampleWasSpecified: false
|
||||||
@ -212,199 +177,8 @@ endpoints:
|
|||||||
custom: []
|
custom: []
|
||||||
cleanUrlParameters:
|
cleanUrlParameters:
|
||||||
project_id: 1
|
project_id: 1
|
||||||
sourceControl_id: 1
|
server_id: 6
|
||||||
queryParameters: []
|
service_id: 22
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters: []
|
|
||||||
cleanBodyParameters: []
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":5,"project_id":null,"global":true,"name":"Martin Welch","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer 458gPbv6deEfkcZ13ahaD6V'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- PUT
|
|
||||||
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: source-controls
|
|
||||||
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: []
|
|
||||||
sourceControl_id:
|
|
||||||
name: sourceControl_id
|
|
||||||
description: 'The ID of the sourceControl.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
sourceControl_id: 1
|
|
||||||
queryParameters: []
|
|
||||||
cleanQueryParameters: []
|
|
||||||
bodyParameters:
|
|
||||||
name:
|
|
||||||
name: name
|
|
||||||
description: 'The name of the storage provider.'
|
|
||||||
required: true
|
|
||||||
example: aut
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
token:
|
|
||||||
name: token
|
|
||||||
description: 'The token if provider requires api token'
|
|
||||||
required: true
|
|
||||||
example: repudiandae
|
|
||||||
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: 'http://howe.net/eaque-assumenda-voluptatem-quo-libero-eius.html'
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
username:
|
|
||||||
name: username
|
|
||||||
description: 'The username if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: consequatur
|
|
||||||
type: string
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
password:
|
|
||||||
name: password
|
|
||||||
description: 'The password if the provider is Bitbucket'
|
|
||||||
required: true
|
|
||||||
example: 'oX/H"pAIt7R2"'
|
|
||||||
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: aut
|
|
||||||
token: repudiandae
|
|
||||||
url: 'http://howe.net/eaque-assumenda-voluptatem-quo-libero-eius.html'
|
|
||||||
username: consequatur
|
|
||||||
password: 'oX/H"pAIt7R2"'
|
|
||||||
global: false
|
|
||||||
fileParameters: []
|
|
||||||
responses:
|
|
||||||
-
|
|
||||||
status: 200
|
|
||||||
content: '{"id":5,"project_id":null,"global":true,"name":"Miss Dulce Nicolas III","provider":"github","created_at":"2025-01-30T22:42:49.000000Z","updated_at":"2025-01-30T22:42:49.000000Z"}'
|
|
||||||
headers: []
|
|
||||||
description: ''
|
|
||||||
custom: []
|
|
||||||
responseFields: []
|
|
||||||
auth:
|
|
||||||
- headers
|
|
||||||
- Authorization
|
|
||||||
- 'Bearer De1a4dEaV5v3Zgh8fPk66bc'
|
|
||||||
controller: null
|
|
||||||
method: null
|
|
||||||
route: null
|
|
||||||
custom: []
|
|
||||||
-
|
|
||||||
httpMethods:
|
|
||||||
- DELETE
|
|
||||||
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
|
||||||
metadata:
|
|
||||||
groupName: source-controls
|
|
||||||
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: []
|
|
||||||
sourceControl_id:
|
|
||||||
name: sourceControl_id
|
|
||||||
description: 'The ID of the sourceControl.'
|
|
||||||
required: true
|
|
||||||
example: 1
|
|
||||||
type: integer
|
|
||||||
enumValues: []
|
|
||||||
exampleWasSpecified: false
|
|
||||||
nullable: false
|
|
||||||
custom: []
|
|
||||||
cleanUrlParameters:
|
|
||||||
project_id: 1
|
|
||||||
sourceControl_id: 1
|
|
||||||
queryParameters: []
|
queryParameters: []
|
||||||
cleanQueryParameters: []
|
cleanQueryParameters: []
|
||||||
bodyParameters: []
|
bodyParameters: []
|
||||||
@ -418,10 +192,352 @@ endpoints:
|
|||||||
description: ''
|
description: ''
|
||||||
custom: []
|
custom: []
|
||||||
responseFields: []
|
responseFields: []
|
||||||
auth:
|
auth: []
|
||||||
- headers
|
controller: null
|
||||||
- Authorization
|
method: null
|
||||||
- 'Bearer EZhd63eafgcV4a651PvkDb8'
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 6
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
service_id:
|
||||||
|
name: service_id
|
||||||
|
description: 'The ID of the service.'
|
||||||
|
required: true
|
||||||
|
example: 22
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
server_id: 6
|
||||||
|
service_id: 22
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
controller: null
|
controller: null
|
||||||
method: null
|
method: null
|
||||||
route: null
|
route: null
|
||||||
|
File diff suppressed because it is too large
Load Diff
408
.scribe/endpoints/13.yaml
Normal file
408
.scribe/endpoints/13.yaml
Normal file
@ -0,0 +1,408 @@
|
|||||||
|
name: source-controls
|
||||||
|
description: ''
|
||||||
|
endpoints:
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/source-controls'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: list
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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":2,"project_id":null,"global":true,"name":"Ms. Elisabeth Okuneva","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":3,"project_id":null,"global":true,"name":"Aleen O''Kon","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- POST
|
||||||
|
uri: 'api/projects/{project_id}/source-controls'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: create
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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'
|
||||||
|
required: true
|
||||||
|
example: gitlab
|
||||||
|
type: string
|
||||||
|
enumValues:
|
||||||
|
- gitlab
|
||||||
|
- github
|
||||||
|
- bitbucket
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
username:
|
||||||
|
name: username
|
||||||
|
description: 'The username if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
password:
|
||||||
|
name: password
|
||||||
|
description: 'The password if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: '|]|{+-'
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
provider: gitlab
|
||||||
|
name: architecto
|
||||||
|
token: architecto
|
||||||
|
url: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
username: architecto
|
||||||
|
password: '|]|{+-'
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":2,"project_id":null,"global":true,"name":"Mrs. Justina Gaylord","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- GET
|
||||||
|
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: show
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: []
|
||||||
|
sourceControl_id:
|
||||||
|
name: sourceControl_id
|
||||||
|
description: 'The ID of the sourceControl.'
|
||||||
|
required: true
|
||||||
|
example: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
sourceControl_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":2,"project_id":null,"global":true,"name":"Misael Runte","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- PUT
|
||||||
|
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: update
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: []
|
||||||
|
sourceControl_id:
|
||||||
|
name: sourceControl_id
|
||||||
|
description: 'The ID of the sourceControl.'
|
||||||
|
required: true
|
||||||
|
example: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
sourceControl_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
username:
|
||||||
|
name: username
|
||||||
|
description: 'The username if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
password:
|
||||||
|
name: password
|
||||||
|
description: 'The password if the provider is Bitbucket'
|
||||||
|
required: true
|
||||||
|
example: '|]|{+-'
|
||||||
|
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: architecto
|
||||||
|
token: architecto
|
||||||
|
url: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
|
||||||
|
username: architecto
|
||||||
|
password: '|]|{+-'
|
||||||
|
global: false
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":2,"project_id":null,"global":true,"name":"Mrs. Justina Gaylord","provider":"github","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
||||||
|
-
|
||||||
|
httpMethods:
|
||||||
|
- DELETE
|
||||||
|
uri: 'api/projects/{project_id}/source-controls/{sourceControl_id}'
|
||||||
|
metadata:
|
||||||
|
groupName: source-controls
|
||||||
|
groupDescription: ''
|
||||||
|
subgroup: ''
|
||||||
|
subgroupDescription: ''
|
||||||
|
title: delete
|
||||||
|
description: ''
|
||||||
|
authenticated: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: []
|
||||||
|
sourceControl_id:
|
||||||
|
name: sourceControl_id
|
||||||
|
description: 'The ID of the sourceControl.'
|
||||||
|
required: true
|
||||||
|
example: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
sourceControl_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
350
.scribe/endpoints/14.yaml
Normal file
350
.scribe/endpoints/14.yaml
Normal file
@ -0,0 +1,350 @@
|
|||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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":4,"project_id":null,"global":true,"name":"harum","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"},{"id":5,"project_id":null,"global":true,"name":"commodi","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
token:
|
||||||
|
name: token
|
||||||
|
description: 'The token if provider requires api token'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
key:
|
||||||
|
name: key
|
||||||
|
description: 'The key if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
secret:
|
||||||
|
name: secret
|
||||||
|
description: 'The secret if provider requires key'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
type: string
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanBodyParameters:
|
||||||
|
provider: architecto
|
||||||
|
name: architecto
|
||||||
|
token: architecto
|
||||||
|
key: architecto
|
||||||
|
secret: architecto
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
storageProvider_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"et","provider":"dropbox","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
storageProvider_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters:
|
||||||
|
name:
|
||||||
|
name: name
|
||||||
|
description: 'The name of the storage provider.'
|
||||||
|
required: true
|
||||||
|
example: architecto
|
||||||
|
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: architecto
|
||||||
|
global: true
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 200
|
||||||
|
content: '{"id":4,"project_id":null,"global":true,"name":"eius","provider":"local","created_at":"2025-06-10T10:21:56.000000Z","updated_at":"2025-06-10T10:21:56.000000Z"}'
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
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: false
|
||||||
|
custom: []
|
||||||
|
headers:
|
||||||
|
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: 1
|
||||||
|
type: integer
|
||||||
|
enumValues: []
|
||||||
|
exampleWasSpecified: false
|
||||||
|
nullable: false
|
||||||
|
custom: []
|
||||||
|
cleanUrlParameters:
|
||||||
|
project_id: 1
|
||||||
|
storageProvider_id: 1
|
||||||
|
queryParameters: []
|
||||||
|
cleanQueryParameters: []
|
||||||
|
bodyParameters: []
|
||||||
|
cleanBodyParameters: []
|
||||||
|
fileParameters: []
|
||||||
|
responses:
|
||||||
|
-
|
||||||
|
status: 204
|
||||||
|
content: null
|
||||||
|
headers: []
|
||||||
|
description: ''
|
||||||
|
custom: []
|
||||||
|
responseFields: []
|
||||||
|
auth: []
|
||||||
|
controller: null
|
||||||
|
method: null
|
||||||
|
route: null
|
||||||
|
custom: []
|
@ -3,11 +3,11 @@ # Introduction
|
|||||||
VitoDeploy's API documentation.
|
VitoDeploy's API documentation.
|
||||||
|
|
||||||
<aside>
|
<aside>
|
||||||
<strong>Base URL</strong>: <code>https://your-vito-url</code>
|
<strong>Base URL</strong>: <code>https://vito.test</code>
|
||||||
</aside>
|
</aside>
|
||||||
|
|
||||||
This documentation aims to provide all the information you need to work with our API.
|
This documentation aims to provide all the information you need to work with our API.
|
||||||
|
|
||||||
<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
|
<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
|
||||||
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>
|
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>
|
||||||
|
|
||||||
|
22
README.md
22
README.md
@ -1,5 +1,5 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://github.com/user-attachments/assets/57f77bd5-bd3f-4367-84c0-aff6ecd392b4" alt="VitoDeploy>
|
<img src="https://github.com/user-attachments/assets/b06531f3-2066-436e-a0e3-0a5f1b7d5118" alt="VitoDeploy>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/vitodeploy/vito/actions"><img alt="GitHub Workflow Status" src="https://github.com/vitodeploy/vito/workflows/tests/badge.svg"></a>
|
<a href="https://github.com/vitodeploy/vito/actions"><img alt="GitHub Workflow Status" src="https://github.com/vitodeploy/vito/workflows/tests/badge.svg"></a>
|
||||||
</p>
|
</p>
|
||||||
@ -14,6 +14,14 @@ ## About Vito
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
Version 3 (Alpha):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
bash <(curl -Ls https://raw.githubusercontent.com/vitodeploy/vito/3.x/scripts/install.sh)
|
||||||
|
```
|
||||||
|
|
||||||
|
Version 2:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
bash <(curl -Ls https://raw.githubusercontent.com/vitodeploy/vito/2.x/scripts/install.sh)
|
bash <(curl -Ls https://raw.githubusercontent.com/vitodeploy/vito/2.x/scripts/install.sh)
|
||||||
```
|
```
|
||||||
@ -30,6 +38,8 @@ ## Features
|
|||||||
- Deploy your SSH Keys to the server
|
- Deploy your SSH Keys to the server
|
||||||
- Create and Manage cron jobs on the server
|
- Create and Manage cron jobs on the server
|
||||||
- API
|
- API
|
||||||
|
- Plugins
|
||||||
|
- Export and Import
|
||||||
|
|
||||||
## Useful Links
|
## Useful Links
|
||||||
|
|
||||||
@ -45,14 +55,14 @@ ## Useful Links
|
|||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
- Laravel
|
- Laravel
|
||||||
|
- InertiaJS
|
||||||
|
- ReactJS
|
||||||
|
- Shadcn UI
|
||||||
- PHPSecLib
|
- PHPSecLib
|
||||||
- PHPUnit
|
- PHPUnit
|
||||||
- Tailwindcss
|
- Tailwindcss
|
||||||
- Alpinejs
|
|
||||||
- Livewire
|
|
||||||
- Vite
|
- Vite
|
||||||
- Prettier
|
- Prettier
|
||||||
- Postcss
|
|
||||||
- FilamentPHP
|
|
||||||
- Mobiledetect
|
|
||||||
- Spatie
|
- Spatie
|
||||||
|
- Opcodesio log viewer
|
||||||
|
- Tightenco
|
||||||
|
11
SECURITY.md
11
SECURITY.md
@ -2,11 +2,12 @@ # Security Policy
|
|||||||
|
|
||||||
## Supported Versions
|
## Supported Versions
|
||||||
|
|
||||||
| Version | New Features | Bug Fixes | Security Fixes |
|
| Version | New Features | Bug Fixes | Security Fixes |
|
||||||
|---------|--------------|-----------|----------------------|
|
|---------|--------------|-----------|----------------|
|
||||||
| 0.x | ❌ | ❌ | ❌ |
|
| 0.x | ❌ | ❌ | ❌ |
|
||||||
| 1.x | ❌ | ❌ | ✅ (Until March 2025) |
|
| 1.x | ❌ | ❌ | ❌ |
|
||||||
| 2.x | ✅ | ✅ | ✅ |
|
| 2.x | ❌ | ✅ | ✅ |
|
||||||
|
| 3.x | ✅ | ✅ | ✅ |
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
@ -3,15 +3,24 @@
|
|||||||
namespace App\Actions\CronJob;
|
namespace App\Actions\CronJob;
|
||||||
|
|
||||||
use App\Enums\CronjobStatus;
|
use App\Enums\CronjobStatus;
|
||||||
|
use App\Exceptions\SSHError;
|
||||||
use App\Models\CronJob;
|
use App\Models\CronJob;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
use App\ValidationRules\CronRule;
|
use App\ValidationRules\CronRule;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
|
|
||||||
class CreateCronJob
|
class CreateCronJob
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*
|
||||||
|
* @throws SSHError
|
||||||
|
*/
|
||||||
public function create(Server $server, array $input): CronJob
|
public function create(Server $server, array $input): CronJob
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($input, $server))->validate();
|
||||||
|
|
||||||
$cronJob = new CronJob([
|
$cronJob = new CronJob([
|
||||||
'server_id' => $server->id,
|
'server_id' => $server->id,
|
||||||
'user' => $input['user'],
|
'user' => $input['user'],
|
||||||
@ -28,6 +37,10 @@ public function create(Server $server, array $input): CronJob
|
|||||||
return $cronJob;
|
return $cronJob;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
* @return array<string, array<int, mixed>>
|
||||||
|
*/
|
||||||
public static function rules(array $input, Server $server): array
|
public static function rules(array $input, Server $server): array
|
||||||
{
|
{
|
||||||
$rules = [
|
$rules = [
|
||||||
|
@ -3,11 +3,15 @@
|
|||||||
namespace App\Actions\CronJob;
|
namespace App\Actions\CronJob;
|
||||||
|
|
||||||
use App\Enums\CronjobStatus;
|
use App\Enums\CronjobStatus;
|
||||||
|
use App\Exceptions\SSHError;
|
||||||
use App\Models\CronJob;
|
use App\Models\CronJob;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
|
|
||||||
class DeleteCronJob
|
class DeleteCronJob
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @throws SSHError
|
||||||
|
*/
|
||||||
public function delete(Server $server, CronJob $cronJob): void
|
public function delete(Server $server, CronJob $cronJob): void
|
||||||
{
|
{
|
||||||
$user = $cronJob->user;
|
$user = $cronJob->user;
|
||||||
|
@ -3,11 +3,15 @@
|
|||||||
namespace App\Actions\CronJob;
|
namespace App\Actions\CronJob;
|
||||||
|
|
||||||
use App\Enums\CronjobStatus;
|
use App\Enums\CronjobStatus;
|
||||||
|
use App\Exceptions\SSHError;
|
||||||
use App\Models\CronJob;
|
use App\Models\CronJob;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
|
|
||||||
class DisableCronJob
|
class DisableCronJob
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @throws SSHError
|
||||||
|
*/
|
||||||
public function disable(Server $server, CronJob $cronJob): void
|
public function disable(Server $server, CronJob $cronJob): void
|
||||||
{
|
{
|
||||||
$cronJob->status = CronjobStatus::DISABLING;
|
$cronJob->status = CronjobStatus::DISABLING;
|
||||||
|
68
app/Actions/CronJob/EditCronJob.php
Executable file
68
app/Actions/CronJob/EditCronJob.php
Executable file
@ -0,0 +1,68 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\CronJob;
|
||||||
|
|
||||||
|
use App\Enums\CronjobStatus;
|
||||||
|
use App\Exceptions\SSHError;
|
||||||
|
use App\Models\CronJob;
|
||||||
|
use App\Models\Server;
|
||||||
|
use App\ValidationRules\CronRule;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
|
use Illuminate\Validation\Rule;
|
||||||
|
|
||||||
|
class EditCronJob
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*
|
||||||
|
* @throws SSHError
|
||||||
|
*/
|
||||||
|
public function edit(Server $server, CronJob $cronJob, array $input): CronJob
|
||||||
|
{
|
||||||
|
Validator::make($input, self::rules($input, $server))->validate();
|
||||||
|
|
||||||
|
$cronJob->update([
|
||||||
|
'user' => $input['user'],
|
||||||
|
'command' => $input['command'],
|
||||||
|
'frequency' => $input['frequency'] == 'custom' ? $input['custom'] : $input['frequency'],
|
||||||
|
'status' => CronjobStatus::UPDATING,
|
||||||
|
]);
|
||||||
|
$cronJob->save();
|
||||||
|
|
||||||
|
$server->cron()->update($cronJob->user, CronJob::crontab($server, $cronJob->user));
|
||||||
|
$cronJob->status = CronjobStatus::READY;
|
||||||
|
$cronJob->save();
|
||||||
|
|
||||||
|
return $cronJob;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
* @return array<string, array<int, mixed>>
|
||||||
|
*/
|
||||||
|
public static function rules(array $input, Server $server): array
|
||||||
|
{
|
||||||
|
$rules = [
|
||||||
|
'command' => [
|
||||||
|
'required',
|
||||||
|
],
|
||||||
|
'user' => [
|
||||||
|
'required',
|
||||||
|
Rule::in($server->getSshUsers()),
|
||||||
|
],
|
||||||
|
'frequency' => [
|
||||||
|
'required',
|
||||||
|
new CronRule(acceptCustom: true),
|
||||||
|
],
|
||||||
|
];
|
||||||
|
|
||||||
|
if (isset($input['frequency']) && $input['frequency'] == 'custom') {
|
||||||
|
$rules['custom'] = [
|
||||||
|
'required',
|
||||||
|
new CronRule,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
return $rules;
|
||||||
|
}
|
||||||
|
}
|
@ -3,11 +3,15 @@
|
|||||||
namespace App\Actions\CronJob;
|
namespace App\Actions\CronJob;
|
||||||
|
|
||||||
use App\Enums\CronjobStatus;
|
use App\Enums\CronjobStatus;
|
||||||
|
use App\Exceptions\SSHError;
|
||||||
use App\Models\CronJob;
|
use App\Models\CronJob;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
|
|
||||||
class EnableCronJob
|
class EnableCronJob
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @throws SSHError
|
||||||
|
*/
|
||||||
public function enable(Server $server, CronJob $cronJob): void
|
public function enable(Server $server, CronJob $cronJob): void
|
||||||
{
|
{
|
||||||
$cronJob->status = CronjobStatus::ENABLING;
|
$cronJob->status = CronjobStatus::ENABLING;
|
||||||
|
@ -5,20 +5,33 @@
|
|||||||
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\Support\Facades\Validator;
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($server, $input))->validate();
|
||||||
|
|
||||||
$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 \App\SSH\Services\Database\Database $databaseHandler */
|
|
||||||
$databaseHandler = $server->database()->handler();
|
/** @var Service $service */
|
||||||
$databaseHandler->create($database->name);
|
$service = $server->database();
|
||||||
|
|
||||||
|
/** @var \App\Services\Database\Database $databaseHandler */
|
||||||
|
$databaseHandler = $service->handler();
|
||||||
|
$databaseHandler->create($database->name, $database->charset, $database->collation);
|
||||||
$database->status = DatabaseStatus::READY;
|
$database->status = DatabaseStatus::READY;
|
||||||
$database->save();
|
$database->save();
|
||||||
|
|
||||||
@ -32,6 +45,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 +56,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']) {
|
||||||
|
@ -5,17 +5,24 @@
|
|||||||
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\SSH\Services\Database\Database;
|
use App\Models\Service;
|
||||||
|
use App\Services\Database\Database;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($server, $input))->validate();
|
||||||
|
|
||||||
$databaseUser = new DatabaseUser([
|
$databaseUser = new DatabaseUser([
|
||||||
'server_id' => $server->id,
|
'server_id' => $server->id,
|
||||||
'username' => $input['username'],
|
'username' => $input['username'],
|
||||||
@ -23,8 +30,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 +52,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
|
||||||
|
@ -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\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);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -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\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();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -5,16 +5,23 @@
|
|||||||
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\Support\Facades\Validator;
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($databaseUser->server))->validate();
|
||||||
|
|
||||||
if (! isset($input['databases']) || ! is_array($input['databases'])) {
|
if (! isset($input['databases']) || ! is_array($input['databases'])) {
|
||||||
$input['databases'] = [];
|
$input['databases'] = [];
|
||||||
}
|
}
|
||||||
@ -29,14 +36,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\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,7 +62,10 @@ public function link(DatabaseUser $databaseUser, array $input): DatabaseUser
|
|||||||
return $databaseUser;
|
return $databaseUser;
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function rules(Server $server, array $input): array
|
/**
|
||||||
|
* @return array<string, mixed>
|
||||||
|
*/
|
||||||
|
public static function rules(Server $server): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
'databases.*' => [
|
'databases.*' => [
|
||||||
|
@ -8,17 +8,22 @@
|
|||||||
use App\Models\Backup;
|
use App\Models\Backup;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
use Illuminate\Auth\Access\AuthorizationException;
|
use Illuminate\Auth\Access\AuthorizationException;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
class ManageBackup
|
class ManageBackup
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*
|
||||||
* @throws AuthorizationException
|
* @throws AuthorizationException
|
||||||
* @throws ValidationException
|
* @throws ValidationException
|
||||||
*/
|
*/
|
||||||
public function create(Server $server, array $input): Backup
|
public function create(Server $server, array $input): Backup
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($server, $input))->validate();
|
||||||
|
|
||||||
$backup = new Backup([
|
$backup = new Backup([
|
||||||
'type' => 'database',
|
'type' => 'database',
|
||||||
'server_id' => $server->id,
|
'server_id' => $server->id,
|
||||||
@ -35,6 +40,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 +55,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;
|
||||||
@ -57,9 +65,13 @@ public function delete(Backup $backup): void
|
|||||||
}
|
}
|
||||||
|
|
||||||
$backup->delete();
|
$backup->delete();
|
||||||
});
|
})->onQueue('ssh');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @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 = [
|
||||||
@ -83,7 +95,7 @@ public static function rules(Server $server, array $input): array
|
|||||||
->where('status', DatabaseStatus::READY),
|
->where('status', DatabaseStatus::READY),
|
||||||
],
|
],
|
||||||
];
|
];
|
||||||
if ($input['interval'] == 'custom') {
|
if (isset($input['interval']) && $input['interval'] == 'custom') {
|
||||||
$rules['custom_interval'] = [
|
$rules['custom_interval'] = [
|
||||||
'required',
|
'required',
|
||||||
];
|
];
|
||||||
@ -91,4 +103,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();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -28,8 +28,8 @@ 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();
|
||||||
});
|
})->onQueue('ssh');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -5,36 +5,50 @@
|
|||||||
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\Server;
|
||||||
|
use App\Models\Service;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
|
use Illuminate\Validation\Rule;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($backupFile->backup->server))->validate();
|
||||||
|
|
||||||
/** @var Database $database */
|
/** @var Database $database */
|
||||||
$database = Database::query()->findOrFail($input['database']);
|
$database = Database::query()->findOrFail($input['database']);
|
||||||
$backupFile->status = BackupFileStatus::RESTORING;
|
$backupFile->status = BackupFileStatus::RESTORING;
|
||||||
$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 \App\SSH\Services\Database\Database $databaseHandler */
|
/** @var Service $service */
|
||||||
$databaseHandler = $database->server->database()->handler();
|
$service = $database->server->database();
|
||||||
|
/** @var \App\Services\Database\Database $databaseHandler */
|
||||||
|
$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');
|
})->onQueue('ssh');
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function rules(): array
|
/**
|
||||||
|
* @return array<string, array<string>>
|
||||||
|
*/
|
||||||
|
public static function rules(Server $server): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
'database' => [
|
'database' => [
|
||||||
'required',
|
'required',
|
||||||
'exists:databases,id',
|
Rule::exists('databases', 'id')->where('server_id', $server->id),
|
||||||
],
|
],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
@ -6,7 +6,8 @@
|
|||||||
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\SSH\Services\Database\Database;
|
use App\Models\Service;
|
||||||
|
use App\Services\Database\Database;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
|
|
||||||
class RunBackup
|
class RunBackup
|
||||||
@ -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,12 +34,12 @@ 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;
|
||||||
$file->save();
|
$file->save();
|
||||||
})->onConnection('ssh');
|
})->onQueue('ssh');
|
||||||
|
|
||||||
return $file;
|
return $file;
|
||||||
}
|
}
|
||||||
|
51
app/Actions/Database/SyncDatabaseUsers.php
Normal file
51
app/Actions/Database/SyncDatabaseUsers.php
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\Database;
|
||||||
|
|
||||||
|
use App\Enums\DatabaseUserStatus;
|
||||||
|
use App\Models\DatabaseUser;
|
||||||
|
use App\Models\Server;
|
||||||
|
use App\Models\Service;
|
||||||
|
use App\Services\Database\Database;
|
||||||
|
|
||||||
|
class SyncDatabaseUsers
|
||||||
|
{
|
||||||
|
public function sync(Server $server): void
|
||||||
|
{
|
||||||
|
$service = $server->database();
|
||||||
|
if (! $service instanceof 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();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
63
app/Actions/Database/SyncDatabases.php
Normal file
63
app/Actions/Database/SyncDatabases.php
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\Database;
|
||||||
|
|
||||||
|
use App\Enums\DatabaseStatus;
|
||||||
|
use App\Models\Server;
|
||||||
|
use App\Models\Service;
|
||||||
|
use App\Services\Database\Database;
|
||||||
|
|
||||||
|
class SyncDatabases
|
||||||
|
{
|
||||||
|
public function sync(Server $server): void
|
||||||
|
{
|
||||||
|
$service = $server->database();
|
||||||
|
if (! $service instanceof 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],
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -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 [
|
||||||
|
@ -5,12 +5,21 @@
|
|||||||
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\SSH\Services\Firewall\Firewall;
|
use App\Models\Service;
|
||||||
|
use App\Services\Firewall\Firewall;
|
||||||
|
use Exception;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($input))->validate();
|
||||||
|
|
||||||
$sourceAny = $input['source_any'] ?? empty($input['source'] ?? null);
|
$sourceAny = $input['source_any'] ?? empty($input['source'] ?? null);
|
||||||
$rule = new FirewallRule([
|
$rule = new FirewallRule([
|
||||||
'name' => $input['name'],
|
'name' => $input['name'],
|
||||||
@ -25,13 +34,19 @@ public function create(Server $server, array $input): FirewallRule
|
|||||||
|
|
||||||
$rule->save();
|
$rule->save();
|
||||||
|
|
||||||
dispatch(fn () => $this->applyRule($rule));
|
dispatch(fn () => $this->applyRule($rule))->onQueue('ssh');
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($input))->validate();
|
||||||
|
|
||||||
$sourceAny = $input['source_any'] ?? empty($input['source'] ?? null);
|
$sourceAny = $input['source_any'] ?? empty($input['source'] ?? null);
|
||||||
$rule->update([
|
$rule->update([
|
||||||
'name' => $input['name'],
|
'name' => $input['name'],
|
||||||
@ -43,7 +58,7 @@ public function update(FirewallRule $rule, array $input): FirewallRule
|
|||||||
'status' => FirewallRuleStatus::UPDATING,
|
'status' => FirewallRuleStatus::UPDATING,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
dispatch(fn () => $this->applyRule($rule));
|
dispatch(fn () => $this->applyRule($rule))->onQueue('ssh');
|
||||||
|
|
||||||
return $rule;
|
return $rule;
|
||||||
}
|
}
|
||||||
@ -53,21 +68,23 @@ public function delete(FirewallRule $rule): void
|
|||||||
$rule->status = FirewallRuleStatus::DELETING;
|
$rule->status = FirewallRuleStatus::DELETING;
|
||||||
$rule->save();
|
$rule->save();
|
||||||
|
|
||||||
dispatch(fn () => $this->applyRule($rule));
|
dispatch(fn () => $this->applyRule($rule))->onQueue('ssh');
|
||||||
}
|
}
|
||||||
|
|
||||||
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,9 +97,13 @@ protected function applyRule($rule): void
|
|||||||
$rule->save();
|
$rule->save();
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function rules(): array
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
* @return array<string, array<string>>
|
||||||
|
*/
|
||||||
|
public static function rules(array $input): array
|
||||||
{
|
{
|
||||||
return [
|
$rules = [
|
||||||
'name' => [
|
'name' => [
|
||||||
'required',
|
'required',
|
||||||
'string',
|
'string',
|
||||||
@ -113,5 +134,12 @@ public static function rules(): array
|
|||||||
'max:32',
|
'max:32',
|
||||||
],
|
],
|
||||||
];
|
];
|
||||||
|
|
||||||
|
if (isset($input['source_any']) && $input['source_any'] === false) {
|
||||||
|
$rules['source'] = ['required', 'ip'];
|
||||||
|
$rules['mask'] = ['required', 'numeric', 'min:1', 'max:32'];
|
||||||
|
}
|
||||||
|
|
||||||
|
return $rules;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -7,14 +7,25 @@
|
|||||||
use Illuminate\Contracts\Database\Query\Expression;
|
use Illuminate\Contracts\Database\Query\Expression;
|
||||||
use Illuminate\Support\Collection;
|
use Illuminate\Support\Collection;
|
||||||
use Illuminate\Support\Facades\DB;
|
use Illuminate\Support\Facades\DB;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
|
use stdClass;
|
||||||
|
|
||||||
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']) {
|
Validator::make($input, self::rules($input))->validate();
|
||||||
|
|
||||||
|
if (isset($input['from'])) {
|
||||||
$input['from'] = Carbon::parse($input['from'])->format('Y-m-d').' 00:00:00';
|
$input['from'] = Carbon::parse($input['from'])->format('Y-m-d').' 00:00:00';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isset($input['to'])) {
|
||||||
$input['to'] = Carbon::parse($input['to'])->format('Y-m-d').' 23:59:59';
|
$input['to'] = Carbon::parse($input['to'])->format('Y-m-d').' 23:59:59';
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -32,6 +43,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 +71,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 +90,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 +102,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 +130,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 = [
|
||||||
@ -125,8 +152,8 @@ public static function rules(array $input): array
|
|||||||
];
|
];
|
||||||
|
|
||||||
if (isset($input['period']) && $input['period'] === 'custom') {
|
if (isset($input['period']) && $input['period'] === 'custom') {
|
||||||
$rules['from'] = ['required', 'date', 'before:to'];
|
$rules['from'] = ['required', 'date', 'before_or_equal:to'];
|
||||||
$rules['to'] = ['required', 'date', 'after:from'];
|
$rules['to'] = ['required', 'date', 'after_or_equal:from'];
|
||||||
}
|
}
|
||||||
|
|
||||||
return $rules;
|
return $rules;
|
||||||
|
@ -3,19 +3,32 @@
|
|||||||
namespace App\Actions\Monitoring;
|
namespace App\Actions\Monitoring;
|
||||||
|
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
|
use App\Models\Service;
|
||||||
|
use App\Services\ServiceInterface;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
$service = $server->monitoring();
|
Validator::make($input, self::rules())->validate();
|
||||||
|
|
||||||
$data = $service->handler()->data();
|
/** @var Service $service */
|
||||||
|
$service = $server->monitoring();
|
||||||
|
/** @var ServiceInterface $handler */
|
||||||
|
$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 [
|
||||||
|
@ -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\SSH\Services\NodeJS\NodeJS;
|
use App\Models\Service;
|
||||||
|
use App\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())) {
|
||||||
|
@ -1,45 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace App\Actions\NodeJS;
|
|
||||||
|
|
||||||
use App\Enums\NodeJS;
|
|
||||||
use App\Enums\ServiceStatus;
|
|
||||||
use App\Models\Server;
|
|
||||||
use App\Models\Service;
|
|
||||||
use Illuminate\Validation\Rule;
|
|
||||||
|
|
||||||
class InstallNewNodeJsVersion
|
|
||||||
{
|
|
||||||
public function install(Server $server, array $input): void
|
|
||||||
{
|
|
||||||
$nodejs = new Service([
|
|
||||||
'server_id' => $server->id,
|
|
||||||
'type' => 'nodejs',
|
|
||||||
'type_data' => [],
|
|
||||||
'name' => 'nodejs',
|
|
||||||
'version' => $input['version'],
|
|
||||||
'status' => ServiceStatus::INSTALLING,
|
|
||||||
'is_default' => false,
|
|
||||||
]);
|
|
||||||
$nodejs->save();
|
|
||||||
|
|
||||||
dispatch(function () use ($nodejs) {
|
|
||||||
$nodejs->handler()->install();
|
|
||||||
$nodejs->status = ServiceStatus::READY;
|
|
||||||
$nodejs->save();
|
|
||||||
})->catch(function () use ($nodejs) {
|
|
||||||
$nodejs->delete();
|
|
||||||
})->onConnection('ssh');
|
|
||||||
}
|
|
||||||
|
|
||||||
public static function rules(Server $server): array
|
|
||||||
{
|
|
||||||
return [
|
|
||||||
'version' => [
|
|
||||||
'required',
|
|
||||||
Rule::in(config('core.nodejs_versions')),
|
|
||||||
Rule::notIn(array_merge($server->installedNodejsVersions(), [NodeJS::NONE])),
|
|
||||||
],
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,53 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace App\Actions\NodeJS;
|
|
||||||
|
|
||||||
use App\Enums\ServiceStatus;
|
|
||||||
use App\Models\Server;
|
|
||||||
use App\Models\Service;
|
|
||||||
use Illuminate\Support\Facades\Validator;
|
|
||||||
use Illuminate\Validation\ValidationException;
|
|
||||||
|
|
||||||
class UninstallNodeJS
|
|
||||||
{
|
|
||||||
public function uninstall(Server $server, array $input): void
|
|
||||||
{
|
|
||||||
$this->validate($server, $input);
|
|
||||||
|
|
||||||
/** @var Service $nodejs */
|
|
||||||
$nodejs = $server->nodejs($input['version']);
|
|
||||||
$nodejs->status = ServiceStatus::UNINSTALLING;
|
|
||||||
$nodejs->save();
|
|
||||||
|
|
||||||
dispatch(function () use ($nodejs) {
|
|
||||||
$nodejs->handler()->uninstall();
|
|
||||||
$nodejs->delete();
|
|
||||||
})->catch(function () use ($nodejs) {
|
|
||||||
$nodejs->status = ServiceStatus::FAILED;
|
|
||||||
$nodejs->save();
|
|
||||||
})->onConnection('ssh');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @throws ValidationException
|
|
||||||
*/
|
|
||||||
private function validate(Server $server, array $input): void
|
|
||||||
{
|
|
||||||
Validator::make($input, [
|
|
||||||
'version' => 'required|string',
|
|
||||||
])->validate();
|
|
||||||
|
|
||||||
if (! in_array($input['version'], $server->installedNodejsVersions())) {
|
|
||||||
throw ValidationException::withMessages(
|
|
||||||
['version' => __('This version is not installed')]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
$hasSite = $server->sites()->where('nodejs_version', $input['version'])->first();
|
|
||||||
if ($hasSite) {
|
|
||||||
throw ValidationException::withMessages(
|
|
||||||
['version' => __('Cannot uninstall this version because some sites are using it!')]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -4,22 +4,27 @@
|
|||||||
|
|
||||||
use App\Models\NotificationChannel;
|
use App\Models\NotificationChannel;
|
||||||
use App\Models\User;
|
use App\Models\User;
|
||||||
|
use App\NotificationChannels\Email;
|
||||||
use Exception;
|
use Exception;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($input))->validate();
|
||||||
|
|
||||||
$channel = new NotificationChannel([
|
$channel = new NotificationChannel([
|
||||||
'user_id' => $user->id,
|
'user_id' => $user->id,
|
||||||
'provider' => $input['provider'],
|
'provider' => $input['provider'],
|
||||||
'label' => $input['label'],
|
'label' => $input['name'],
|
||||||
'project_id' => isset($input['global']) && $input['global'] ? null : $user->current_project_id,
|
'project_id' => isset($input['global']) && $input['global'] ? null : $user->current_project_id,
|
||||||
]);
|
]);
|
||||||
$channel->data = $channel->provider()->createData($input);
|
$channel->data = $channel->provider()->createData($input);
|
||||||
@ -29,7 +34,7 @@ public function add(User $user, array $input): void
|
|||||||
if (! $channel->provider()->connect()) {
|
if (! $channel->provider()->connect()) {
|
||||||
$channel->delete();
|
$channel->delete();
|
||||||
|
|
||||||
if ($channel->provider === \App\Enums\NotificationChannel::EMAIL) {
|
if ($channel->provider === Email::id()) {
|
||||||
throw ValidationException::withMessages([
|
throw ValidationException::withMessages([
|
||||||
'email' => __('Could not connect! Make sure you configured `.env` file correctly.'),
|
'email' => __('Could not connect! Make sure you configured `.env` file correctly.'),
|
||||||
]);
|
]);
|
||||||
@ -42,26 +47,36 @@ 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 = [
|
||||||
'provider' => [
|
'provider' => [
|
||||||
'required',
|
'required',
|
||||||
Rule::in(config('core.notification_channels_providers')),
|
Rule::in(array_keys(config('notification-channel.providers'))),
|
||||||
],
|
],
|
||||||
'label' => 'required',
|
'name' => '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'])) {
|
||||||
|
@ -7,19 +7,26 @@
|
|||||||
|
|
||||||
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([
|
||||||
'label' => $input['label'],
|
'label' => $input['name'],
|
||||||
'project_id' => isset($input['global']) && $input['global'] ? null : $user->current_project_id,
|
'project_id' => isset($input['global']) && $input['global'] ? null : $user->current_project_id,
|
||||||
]);
|
]);
|
||||||
$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 [
|
||||||
'label' => 'required',
|
'name' => 'required',
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -3,24 +3,44 @@
|
|||||||
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\SSH\Services\PHP\PHP;
|
use App\Models\Service;
|
||||||
|
use App\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']);
|
||||||
|
|
||||||
|
if ($service->is_default) {
|
||||||
|
throw ValidationException::withMessages(
|
||||||
|
['version' => __('This version is already the default CLI')]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/** @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())) {
|
||||||
|
@ -4,17 +4,25 @@
|
|||||||
|
|
||||||
use App\Enums\PHPIniType;
|
use App\Enums\PHPIniType;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
use App\SSH\Services\PHP\PHP;
|
use App\Models\Service;
|
||||||
|
use App\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, [
|
||||||
|
@ -1,48 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace App\Actions\PHP;
|
|
||||||
|
|
||||||
use App\Enums\PHP;
|
|
||||||
use App\Enums\ServiceStatus;
|
|
||||||
use App\Models\Server;
|
|
||||||
use App\Models\Service;
|
|
||||||
use Illuminate\Validation\Rule;
|
|
||||||
|
|
||||||
class InstallNewPHP
|
|
||||||
{
|
|
||||||
public function install(Server $server, array $input): void
|
|
||||||
{
|
|
||||||
$php = new Service([
|
|
||||||
'server_id' => $server->id,
|
|
||||||
'type' => 'php',
|
|
||||||
'type_data' => [
|
|
||||||
'extensions' => [],
|
|
||||||
'settings' => config('core.php_settings'),
|
|
||||||
],
|
|
||||||
'name' => 'php',
|
|
||||||
'version' => $input['version'],
|
|
||||||
'status' => ServiceStatus::INSTALLING,
|
|
||||||
'is_default' => false,
|
|
||||||
]);
|
|
||||||
$php->save();
|
|
||||||
|
|
||||||
dispatch(function () use ($php) {
|
|
||||||
$php->handler()->install();
|
|
||||||
$php->status = ServiceStatus::READY;
|
|
||||||
$php->save();
|
|
||||||
})->catch(function () use ($php) {
|
|
||||||
$php->delete();
|
|
||||||
})->onConnection('ssh');
|
|
||||||
}
|
|
||||||
|
|
||||||
public static function rules(Server $server): array
|
|
||||||
{
|
|
||||||
return [
|
|
||||||
'version' => [
|
|
||||||
'required',
|
|
||||||
Rule::in(config('core.php_versions')),
|
|
||||||
Rule::notIn(array_merge($server->installedPHPVersions(), [PHP::NONE])),
|
|
||||||
],
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
@ -2,17 +2,22 @@
|
|||||||
|
|
||||||
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\Services\PHP\PHP;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
class InstallPHPExtension
|
class InstallPHPExtension
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*/
|
||||||
public function install(Server $server, array $input): Service
|
public function install(Server $server, array $input): Service
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($server))->validate();
|
||||||
|
|
||||||
/** @var Service $service */
|
/** @var Service $service */
|
||||||
$service = $server->php($input['version']);
|
$service = $server->php($input['version']);
|
||||||
|
|
||||||
@ -23,36 +28,36 @@ 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']]));
|
||||||
$service->type_data = $typeData;
|
$service->type_data = $typeData;
|
||||||
$service->save();
|
$service->save();
|
||||||
})->onConnection('ssh');
|
})->onQueue('ssh-unique');
|
||||||
|
|
||||||
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 [
|
||||||
'extension' => [
|
'extension' => [
|
||||||
'required',
|
'required',
|
||||||
Rule::in(config('core.php_extensions')),
|
Rule::in(config('service.services.php.data.extensions', []) ?? []),
|
||||||
],
|
],
|
||||||
'version' => [
|
'version' => [
|
||||||
'required',
|
'required',
|
||||||
|
@ -1,53 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace App\Actions\PHP;
|
|
||||||
|
|
||||||
use App\Enums\ServiceStatus;
|
|
||||||
use App\Models\Server;
|
|
||||||
use App\Models\Service;
|
|
||||||
use Illuminate\Support\Facades\Validator;
|
|
||||||
use Illuminate\Validation\ValidationException;
|
|
||||||
|
|
||||||
class UninstallPHP
|
|
||||||
{
|
|
||||||
public function uninstall(Server $server, array $input): void
|
|
||||||
{
|
|
||||||
$this->validate($server, $input);
|
|
||||||
|
|
||||||
/** @var Service $php */
|
|
||||||
$php = $server->php($input['version']);
|
|
||||||
$php->status = ServiceStatus::UNINSTALLING;
|
|
||||||
$php->save();
|
|
||||||
|
|
||||||
dispatch(function () use ($php) {
|
|
||||||
$php->handler()->uninstall();
|
|
||||||
$php->delete();
|
|
||||||
})->catch(function () use ($php) {
|
|
||||||
$php->status = ServiceStatus::FAILED;
|
|
||||||
$php->save();
|
|
||||||
})->onConnection('ssh');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @throws ValidationException
|
|
||||||
*/
|
|
||||||
private function validate(Server $server, array $input): void
|
|
||||||
{
|
|
||||||
Validator::make($input, [
|
|
||||||
'version' => 'required|string',
|
|
||||||
])->validate();
|
|
||||||
|
|
||||||
if (! in_array($input['version'], $server->installedPHPVersions())) {
|
|
||||||
throw ValidationException::withMessages(
|
|
||||||
['version' => __('This version is not installed')]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
$hasSite = $server->sites()->where('php_version', $input['version'])->first();
|
|
||||||
if ($hasSite) {
|
|
||||||
throw ValidationException::withMessages(
|
|
||||||
['version' => __('Cannot uninstall this version because some sites are using it!')]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -4,8 +4,10 @@
|
|||||||
|
|
||||||
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\Facades\Validator;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
@ -14,10 +16,15 @@
|
|||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($server))->validate();
|
||||||
|
|
||||||
|
/** @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 +55,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 [
|
||||||
|
@ -5,12 +5,18 @@
|
|||||||
use App\Models\Project;
|
use App\Models\Project;
|
||||||
use App\Models\User;
|
use App\Models\User;
|
||||||
use Illuminate\Database\Query\Builder;
|
use Illuminate\Database\Query\Builder;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($project))->validate();
|
||||||
|
|
||||||
/** @var User $user */
|
/** @var User $user */
|
||||||
$user = User::query()->findOrFail($input['user']);
|
$user = User::query()->findOrFail($input['user']);
|
||||||
|
|
||||||
@ -18,13 +24,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);
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
|
@ -8,10 +8,15 @@
|
|||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules())->validate();
|
||||||
|
|
||||||
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 +32,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 +48,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();
|
||||||
|
@ -4,21 +4,29 @@
|
|||||||
|
|
||||||
use App\Models\Project;
|
use App\Models\Project;
|
||||||
use App\Models\User;
|
use App\Models\User;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
class DeleteProject
|
class DeleteProject
|
||||||
{
|
{
|
||||||
public function delete(User $user, Project $project): void
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*/
|
||||||
|
public function delete(User $user, Project $project, array $input): void
|
||||||
{
|
{
|
||||||
|
Validator::make($input, [
|
||||||
|
'name' => 'required',
|
||||||
|
])->validate();
|
||||||
|
|
||||||
if ($user->projects()->count() === 1) {
|
if ($user->projects()->count() === 1) {
|
||||||
throw ValidationException::withMessages([
|
throw ValidationException::withMessages([
|
||||||
'project' => __('Cannot delete the last project.'),
|
'name' => __('Cannot delete the last project.'),
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($user->current_project_id == $project->id) {
|
if ($user->current_project_id == $project->id) {
|
||||||
throw ValidationException::withMessages([
|
throw ValidationException::withMessages([
|
||||||
'project' => __('Cannot delete your current project.'),
|
'name' => __('Cannot delete your current project.'),
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -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();
|
||||||
|
@ -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',
|
|
||||||
],
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,13 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace App\Actions\Queue;
|
|
||||||
|
|
||||||
use App\Models\Queue;
|
|
||||||
|
|
||||||
class DeleteQueue
|
|
||||||
{
|
|
||||||
public function delete(Queue $queue): void
|
|
||||||
{
|
|
||||||
$queue->delete();
|
|
||||||
}
|
|
||||||
}
|
|
@ -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',
|
|
||||||
],
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
@ -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());
|
|
||||||
}
|
|
||||||
}
|
|
@ -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');
|
|
||||||
}
|
|
||||||
}
|
|
80
app/Actions/Redirect/CreateRedirect.php
Normal file
80
app/Actions/Redirect/CreateRedirect.php
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\Redirect;
|
||||||
|
|
||||||
|
use App\Enums\RedirectStatus;
|
||||||
|
use App\Models\Redirect;
|
||||||
|
use App\Models\Service;
|
||||||
|
use App\Models\Site;
|
||||||
|
use App\Services\Webserver\Webserver;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
|
use Illuminate\Validation\Rule;
|
||||||
|
|
||||||
|
class CreateRedirect
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*/
|
||||||
|
public function create(Site $site, array $input): Redirect
|
||||||
|
{
|
||||||
|
Validator::make($input, self::rules($site))->validate();
|
||||||
|
|
||||||
|
$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, regenerate: [
|
||||||
|
'redirects',
|
||||||
|
]);
|
||||||
|
$redirect->status = RedirectStatus::READY;
|
||||||
|
$redirect->save();
|
||||||
|
})
|
||||||
|
->catch(function () use ($redirect): void {
|
||||||
|
$redirect->status = RedirectStatus::FAILED;
|
||||||
|
$redirect->save();
|
||||||
|
})
|
||||||
|
->onQueue('ssh-unique');
|
||||||
|
|
||||||
|
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,
|
||||||
|
]),
|
||||||
|
],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
32
app/Actions/Redirect/DeleteRedirect.php
Normal file
32
app/Actions/Redirect/DeleteRedirect.php
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\Redirect;
|
||||||
|
|
||||||
|
use App\Enums\RedirectStatus;
|
||||||
|
use App\Models\Redirect;
|
||||||
|
use App\Models\Service;
|
||||||
|
use App\Models\Site;
|
||||||
|
use App\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, regenerate: [
|
||||||
|
'redirects',
|
||||||
|
]);
|
||||||
|
$redirect->delete();
|
||||||
|
})->catch(function () use ($redirect): void {
|
||||||
|
$redirect->status = RedirectStatus::FAILED;
|
||||||
|
$redirect->save();
|
||||||
|
})->onQueue('ssh-unique');
|
||||||
|
}
|
||||||
|
}
|
@ -11,6 +11,8 @@ public function activate(Ssl $ssl): void
|
|||||||
$ssl->site->ssls()->update(['is_active' => false]);
|
$ssl->site->ssls()->update(['is_active' => false]);
|
||||||
$ssl->is_active = true;
|
$ssl->is_active = true;
|
||||||
$ssl->save();
|
$ssl->save();
|
||||||
$ssl->site->webserver()->updateVHost($ssl->site);
|
$ssl->site->webserver()->updateVHost($ssl->site, regenerate: [
|
||||||
|
'port',
|
||||||
|
]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -5,19 +5,25 @@
|
|||||||
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\Services\Webserver\Webserver;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($input))->validate();
|
||||||
|
|
||||||
$site->ssls()
|
$site->ssls()
|
||||||
->where('type', $input['type'])
|
->where('type', $input['type'])
|
||||||
->where('status', SslStatus::FAILED)
|
->where('status', SslStatus::FAILED)
|
||||||
@ -40,19 +46,27 @@ 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, regenerate: [
|
||||||
})->catch(function () use ($ssl) {
|
'port',
|
||||||
|
]);
|
||||||
|
})->catch(function () use ($ssl): void {
|
||||||
$ssl->status = SslStatus::FAILED;
|
$ssl->status = SslStatus::FAILED;
|
||||||
$ssl->save();
|
$ssl->save();
|
||||||
})->onConnection('ssh');
|
})->onQueue('ssh-unique');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @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 = [
|
||||||
|
17
app/Actions/SSL/DeactivateSSL.php
Normal file
17
app/Actions/SSL/DeactivateSSL.php
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\SSL;
|
||||||
|
|
||||||
|
use App\Models\Ssl;
|
||||||
|
|
||||||
|
class DeactivateSSL
|
||||||
|
{
|
||||||
|
public function deactivate(Ssl $ssl): void
|
||||||
|
{
|
||||||
|
$ssl->is_active = false;
|
||||||
|
$ssl->save();
|
||||||
|
$ssl->site->webserver()->updateVHost($ssl->site, regenerate: [
|
||||||
|
'port',
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
@ -3,8 +3,9 @@
|
|||||||
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\Services\Webserver\Webserver;
|
||||||
|
|
||||||
class DeleteSSL
|
class DeleteSSL
|
||||||
{
|
{
|
||||||
@ -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();
|
||||||
}
|
}
|
||||||
|
@ -4,11 +4,17 @@
|
|||||||
|
|
||||||
use App\Models\Script;
|
use App\Models\Script;
|
||||||
use App\Models\User;
|
use App\Models\User;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules())->validate();
|
||||||
|
|
||||||
$script = new Script([
|
$script = new Script([
|
||||||
'user_id' => $user->id,
|
'user_id' => $user->id,
|
||||||
'name' => $input['name'],
|
'name' => $input['name'],
|
||||||
@ -20,6 +26,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 [
|
||||||
|
@ -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 [
|
||||||
|
@ -7,48 +7,80 @@
|
|||||||
use App\Models\ScriptExecution;
|
use App\Models\ScriptExecution;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
use App\Models\ServerLog;
|
use App\Models\ServerLog;
|
||||||
|
use App\Models\User;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
|
|
||||||
class ExecuteScript
|
class ExecuteScript
|
||||||
{
|
{
|
||||||
public function execute(Script $script, array $input): ScriptExecution
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*/
|
||||||
|
public function execute(Script $script, User $user, array $input): ScriptExecution
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($script, $input))->validate();
|
||||||
|
|
||||||
|
$variables = [];
|
||||||
|
foreach ($script->getVariables() as $variable) {
|
||||||
|
if (array_key_exists($variable, $input)) {
|
||||||
|
$variables[$variable] = $input[$variable] ?? '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @var Server $server */
|
||||||
|
$server = Server::query()->findOrFail($input['server']);
|
||||||
|
|
||||||
|
if (! $user->can('update', $server)) {
|
||||||
|
abort(403, 'You do not have permission to execute scripts on this server.');
|
||||||
|
}
|
||||||
|
|
||||||
$execution = new ScriptExecution([
|
$execution = new ScriptExecution([
|
||||||
'script_id' => $script->id,
|
'script_id' => $script->id,
|
||||||
'server_id' => $input['server'],
|
'server_id' => $input['server'],
|
||||||
'user' => $input['user'],
|
'user' => $input['user'],
|
||||||
'variables' => $input['variables'] ?? [],
|
'variables' => $variables,
|
||||||
'status' => ScriptExecutionStatus::EXECUTING,
|
'status' => ScriptExecutionStatus::EXECUTING,
|
||||||
]);
|
]);
|
||||||
$execution->save();
|
$execution->save();
|
||||||
|
|
||||||
dispatch(function () use ($execution, $script) {
|
$log = ServerLog::newLog($execution->server, 'script-'.$script->id.'-'.strtotime('now'));
|
||||||
|
$log->save();
|
||||||
|
|
||||||
|
$execution->server_log_id = $log->id;
|
||||||
|
$execution->save();
|
||||||
|
|
||||||
|
dispatch(function () use ($execution, $log): void {
|
||||||
|
/** @var Server $server */
|
||||||
|
$server = $execution->server;
|
||||||
|
|
||||||
$content = $execution->getContent();
|
$content = $execution->getContent();
|
||||||
$log = ServerLog::make($execution->server, 'script-'.$script->id.'-'.strtotime('now'));
|
|
||||||
$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');
|
})->onQueue('ssh');
|
||||||
|
|
||||||
return $execution;
|
return $execution;
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function rules(array $input): array
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
* @return array<string, mixed>
|
||||||
|
*/
|
||||||
|
public static function rules(Script $script, 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();
|
||||||
}
|
}
|
||||||
|
|
||||||
return [
|
$rules = [
|
||||||
'server' => [
|
'server' => [
|
||||||
'required',
|
'required',
|
||||||
Rule::exists('servers', 'id'),
|
Rule::exists('servers', 'id'),
|
||||||
@ -57,12 +89,16 @@ public static function rules(array $input): array
|
|||||||
'required',
|
'required',
|
||||||
Rule::in($users),
|
Rule::in($users),
|
||||||
],
|
],
|
||||||
'variables' => 'array',
|
];
|
||||||
'variables.*' => [
|
|
||||||
|
foreach ($script->getVariables() as $variable) {
|
||||||
|
$rules[$variable] = [
|
||||||
'required',
|
'required',
|
||||||
'string',
|
'string',
|
||||||
'max:255',
|
'max:255',
|
||||||
],
|
];
|
||||||
];
|
}
|
||||||
|
|
||||||
|
return $rules;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -3,20 +3,18 @@
|
|||||||
namespace App\Actions\Server;
|
namespace App\Actions\Server;
|
||||||
|
|
||||||
use App\Enums\FirewallRuleStatus;
|
use App\Enums\FirewallRuleStatus;
|
||||||
use App\Enums\ServerProvider;
|
|
||||||
use App\Enums\ServerStatus;
|
use App\Enums\ServerStatus;
|
||||||
use App\Enums\ServerType;
|
|
||||||
use App\Exceptions\SSHConnectionError;
|
|
||||||
use App\Facades\Notifier;
|
use App\Facades\Notifier;
|
||||||
use App\Models\Project;
|
use App\Models\Project;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
use App\Models\User;
|
use App\Models\User;
|
||||||
use App\Notifications\ServerInstallationFailed;
|
use App\Notifications\ServerInstallationFailed;
|
||||||
use App\Notifications\ServerInstallationSucceed;
|
use App\ServerProviders\Custom;
|
||||||
use App\ValidationRules\RestrictedIPAddressesRule;
|
use App\ValidationRules\RestrictedIPAddressesRule;
|
||||||
use Exception;
|
use Exception;
|
||||||
use Illuminate\Database\Query\Builder;
|
use Illuminate\Database\Query\Builder;
|
||||||
use Illuminate\Support\Facades\Log;
|
use Illuminate\Support\Facades\Log;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
@ -24,17 +22,23 @@
|
|||||||
|
|
||||||
class CreateServer
|
class CreateServer
|
||||||
{
|
{
|
||||||
|
protected Server $server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @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([
|
Validator::make($input, self::rules($project, $input))->validate();
|
||||||
|
|
||||||
|
$this->server = new Server([
|
||||||
'project_id' => $project->id,
|
'project_id' => $project->id,
|
||||||
'user_id' => $creator->id,
|
'user_id' => $creator->id,
|
||||||
'name' => $input['name'],
|
'name' => $input['name'],
|
||||||
'ssh_user' => config('core.server_providers_default_user')[$input['provider']][$input['os']],
|
'ssh_user' => data_get(config('server-provider.providers'), $input['provider'].'.default_user') ?? 'root',
|
||||||
'ip' => $input['ip'] ?? '',
|
'ip' => $input['ip'] ?? '',
|
||||||
'port' => $input['port'] ?? 22,
|
'port' => $input['port'] ?? 22,
|
||||||
'os' => $input['os'],
|
'os' => $input['os'],
|
||||||
'type' => ServerType::REGULAR,
|
|
||||||
'provider' => $input['provider'],
|
'provider' => $input['provider'],
|
||||||
'authentication' => [
|
'authentication' => [
|
||||||
'user' => config('core.ssh_user'),
|
'user' => config('core.ssh_user'),
|
||||||
@ -46,32 +50,42 @@ public function create(User $creator, Project $project, array $input): Server
|
|||||||
]);
|
]);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if ($server->provider != 'custom') {
|
if ($this->server->provider != 'custom') {
|
||||||
$server->provider_id = $input['server_provider'];
|
$this->server->provider_id = $input['server_provider'];
|
||||||
}
|
}
|
||||||
|
|
||||||
$server->type_data = $server->type()->data($input);
|
$this->server->provider_data = $this->server->provider()->data($input);
|
||||||
|
|
||||||
$server->provider_data = $server->provider()->data($input);
|
|
||||||
|
|
||||||
// save
|
// save
|
||||||
$server->save();
|
$this->server->save();
|
||||||
|
|
||||||
// create firewall rules
|
// create firewall rules
|
||||||
$this->createFirewallRules($server);
|
$this->createFirewallRules($this->server);
|
||||||
|
|
||||||
// create instance
|
// create instance
|
||||||
$server->provider()->create();
|
$this->server->provider()->create();
|
||||||
|
|
||||||
// add services
|
// create services
|
||||||
$server->type()->createServices($input);
|
$this->createServices();
|
||||||
|
|
||||||
// install server
|
// install server
|
||||||
$this->install($server);
|
dispatch(function (): void {
|
||||||
|
app(InstallServer::class)->run($this->server);
|
||||||
|
})
|
||||||
|
->catch(function (Throwable $e): void {
|
||||||
|
$this->server->update([
|
||||||
|
'status' => ServerStatus::INSTALLATION_FAILED,
|
||||||
|
]);
|
||||||
|
Notifier::send($this->server, new ServerInstallationFailed($this->server));
|
||||||
|
Log::error('server-installation-error', [
|
||||||
|
'error' => (string) $e,
|
||||||
|
]);
|
||||||
|
})
|
||||||
|
->onQueue('ssh');
|
||||||
|
|
||||||
return $server;
|
return $this->server;
|
||||||
} catch (Exception $e) {
|
} catch (Exception $e) {
|
||||||
$server->delete();
|
$this->server->delete();
|
||||||
|
|
||||||
throw ValidationException::withMessages([
|
throw ValidationException::withMessages([
|
||||||
'provider' => $e->getMessage(),
|
'provider' => $e->getMessage(),
|
||||||
@ -79,47 +93,16 @@ public function create(User $creator, Project $project, array $input): Server
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private function install(Server $server): void
|
/**
|
||||||
{
|
* @param array<string, mixed> $input
|
||||||
dispatch(function () use ($server) {
|
* @return array<string, mixed>
|
||||||
$maxWait = 180;
|
*/
|
||||||
while ($maxWait > 0) {
|
|
||||||
sleep(10);
|
|
||||||
$maxWait -= 10;
|
|
||||||
if (! $server->provider()->isRunning()) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
$server->ssh()->connect();
|
|
||||||
break;
|
|
||||||
} catch (SSHConnectionError) {
|
|
||||||
// ignore
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$server->type()->install();
|
|
||||||
$server->update([
|
|
||||||
'status' => ServerStatus::READY,
|
|
||||||
]);
|
|
||||||
Notifier::send($server, new ServerInstallationSucceed($server));
|
|
||||||
})
|
|
||||||
->catch(function (Throwable $e) use ($server) {
|
|
||||||
$server->update([
|
|
||||||
'status' => ServerStatus::INSTALLATION_FAILED,
|
|
||||||
]);
|
|
||||||
Notifier::send($server, new ServerInstallationFailed($server));
|
|
||||||
Log::error('server-installation-error', [
|
|
||||||
'error' => (string) $e,
|
|
||||||
]);
|
|
||||||
})
|
|
||||||
->onConnection('ssh');
|
|
||||||
}
|
|
||||||
|
|
||||||
public static function rules(Project $project, array $input): array
|
public static function rules(Project $project, array $input): array
|
||||||
{
|
{
|
||||||
$rules = [
|
$rules = [
|
||||||
'provider' => [
|
'provider' => [
|
||||||
'required',
|
'required',
|
||||||
Rule::in(config('core.server_providers')),
|
Rule::in(array_keys(config('server-provider.providers'))),
|
||||||
],
|
],
|
||||||
'name' => [
|
'name' => [
|
||||||
'required',
|
'required',
|
||||||
@ -129,28 +112,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'] != Custom::id(), [
|
||||||
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'] == Custom::id(), [
|
||||||
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'] == Custom::id(), [
|
||||||
return isset($input['provider']) && $input['provider'] == ServerProvider::CUSTOM;
|
|
||||||
}, [
|
|
||||||
'required',
|
'required',
|
||||||
'numeric',
|
'numeric',
|
||||||
'min:1',
|
'min:1',
|
||||||
@ -159,27 +136,20 @@ public static function rules(Project $project, array $input): array
|
|||||||
],
|
],
|
||||||
];
|
];
|
||||||
|
|
||||||
return array_merge($rules, self::typeRules($input), self::providerRules($input));
|
return array_merge($rules, self::providerRules($input));
|
||||||
}
|
|
||||||
|
|
||||||
private static function typeRules(array $input): array
|
|
||||||
{
|
|
||||||
if (! isset($input['type']) || ! in_array($input['type'], config('core.server_types'))) {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
$server = new Server(['type' => $input['type']]);
|
|
||||||
|
|
||||||
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 (
|
||||||
! isset($input['provider']) ||
|
! isset($input['provider']) ||
|
||||||
! isset($input['server_provider']) ||
|
! isset($input['server_provider']) ||
|
||||||
! in_array($input['provider'], config('core.server_providers')) ||
|
! config('server-provider.providers.'.$input['provider']) ||
|
||||||
$input['provider'] == ServerProvider::CUSTOM
|
$input['provider'] == Custom::id()
|
||||||
) {
|
) {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
@ -224,4 +194,29 @@ public function createFirewallRules(Server $server): void
|
|||||||
],
|
],
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private function createServices(): void
|
||||||
|
{
|
||||||
|
$this->server->services()->forceDelete();
|
||||||
|
$this->addUfw();
|
||||||
|
$this->addMonitoring();
|
||||||
|
}
|
||||||
|
|
||||||
|
private function addUfw(): void
|
||||||
|
{
|
||||||
|
$this->server->services()->create([
|
||||||
|
'type' => 'firewall',
|
||||||
|
'name' => 'ufw',
|
||||||
|
'version' => 'latest',
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function addMonitoring(): void
|
||||||
|
{
|
||||||
|
$this->server->services()->create([
|
||||||
|
'type' => 'monitoring',
|
||||||
|
'name' => 'remote-monitor',
|
||||||
|
'version' => 'latest',
|
||||||
|
]);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -4,16 +4,22 @@
|
|||||||
|
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
use App\ValidationRules\RestrictedIPAddressesRule;
|
use App\ValidationRules\RestrictedIPAddressesRule;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\Rule;
|
use Illuminate\Validation\Rule;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules($server))->validate();
|
||||||
|
|
||||||
$checkConnection = false;
|
$checkConnection = false;
|
||||||
if (isset($input['name'])) {
|
if (isset($input['name'])) {
|
||||||
$server->name = $input['name'];
|
$server->name = $input['name'];
|
||||||
@ -42,6 +48,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 [
|
||||||
@ -56,6 +65,7 @@ public static function rules(Server $server): array
|
|||||||
Rule::unique('servers')->where('project_id', $server->project_id)->ignore($server->id),
|
Rule::unique('servers')->where('project_id', $server->project_id)->ignore($server->id),
|
||||||
],
|
],
|
||||||
'local_ip' => [
|
'local_ip' => [
|
||||||
|
'nullable',
|
||||||
'string',
|
'string',
|
||||||
Rule::unique('servers')->where('project_id', $server->project_id)->ignore($server->id),
|
Rule::unique('servers')->where('project_id', $server->project_id)->ignore($server->id),
|
||||||
],
|
],
|
||||||
|
103
app/ServerTypes/AbstractType.php → app/Actions/Server/InstallServer.php
Executable file → Normal file
103
app/ServerTypes/AbstractType.php → app/Actions/Server/InstallServer.php
Executable file → Normal file
@ -1,19 +1,46 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace App\ServerTypes;
|
namespace App\Actions\Server;
|
||||||
|
|
||||||
|
use App\Enums\ServerStatus;
|
||||||
use App\Enums\ServiceStatus;
|
use App\Enums\ServiceStatus;
|
||||||
|
use App\Exceptions\SSHConnectionError;
|
||||||
use App\Exceptions\SSHError;
|
use App\Exceptions\SSHError;
|
||||||
|
use App\Facades\Notifier;
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
use App\SSH\Services\PHP\PHP;
|
use App\Notifications\ServerInstallationSucceed;
|
||||||
|
use App\Services\PHP\PHP;
|
||||||
|
|
||||||
abstract class AbstractType implements ServerType
|
class InstallServer
|
||||||
{
|
{
|
||||||
protected Server $server;
|
protected Server $server;
|
||||||
|
|
||||||
public function __construct(Server $server)
|
/**
|
||||||
|
* @throws SSHError
|
||||||
|
*/
|
||||||
|
public function run(Server $server): void
|
||||||
{
|
{
|
||||||
$this->server = $server;
|
$this->server = $server;
|
||||||
|
|
||||||
|
$maxWait = 180;
|
||||||
|
while ($maxWait > 0) {
|
||||||
|
if (! $this->server->provider()->isRunning()) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
$this->server->ssh()->connect();
|
||||||
|
break;
|
||||||
|
} catch (SSHConnectionError) {
|
||||||
|
// ignore
|
||||||
|
}
|
||||||
|
sleep(10);
|
||||||
|
$maxWait -= 10;
|
||||||
|
}
|
||||||
|
$this->install();
|
||||||
|
$this->server->update([
|
||||||
|
'status' => ServerStatus::READY,
|
||||||
|
]);
|
||||||
|
Notifier::send($this->server, new ServerInstallationSucceed($this->server));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -44,6 +71,9 @@ public function install(): void
|
|||||||
$this->progress(100, 'finishing');
|
$this->progress(100, 'finishing');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws SSHError
|
||||||
|
*/
|
||||||
protected function createUser(): void
|
protected function createUser(): void
|
||||||
{
|
{
|
||||||
$this->server->os()->createUser(
|
$this->server->os()->createUser(
|
||||||
@ -58,73 +88,10 @@ protected function createUser(): void
|
|||||||
$this->server->save();
|
$this->server->save();
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function progress(int $percentage, ?string $step = null): void
|
protected function progress(int|float $percentage, ?string $step = null): void
|
||||||
{
|
{
|
||||||
$this->server->progress = $percentage;
|
$this->server->progress = $percentage;
|
||||||
$this->server->progress_step = $step;
|
$this->server->progress_step = $step;
|
||||||
$this->server->save();
|
$this->server->save();
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function addWebserver(string $service): void
|
|
||||||
{
|
|
||||||
if ($service != 'none') {
|
|
||||||
$this->server->services()->create([
|
|
||||||
'type' => 'webserver',
|
|
||||||
'name' => $service,
|
|
||||||
'version' => 'latest',
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function addDatabase(string $service): void
|
|
||||||
{
|
|
||||||
if ($service != 'none') {
|
|
||||||
$this->server->services()->create([
|
|
||||||
'type' => 'database',
|
|
||||||
'name' => config('core.databases_name.'.$service),
|
|
||||||
'version' => config('core.databases_version.'.$service),
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function addPHP(string $version): void
|
|
||||||
{
|
|
||||||
if ($version != 'none') {
|
|
||||||
$this->server->services()->create([
|
|
||||||
'type' => 'php',
|
|
||||||
'type_data' => [
|
|
||||||
'extensions' => [],
|
|
||||||
],
|
|
||||||
'name' => 'php',
|
|
||||||
'version' => $version,
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function addSupervisor(): void
|
|
||||||
{
|
|
||||||
$this->server->services()->create([
|
|
||||||
'type' => 'process_manager',
|
|
||||||
'name' => 'supervisor',
|
|
||||||
'version' => 'latest',
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function addRedis(): void
|
|
||||||
{
|
|
||||||
$this->server->services()->create([
|
|
||||||
'type' => 'memory_database',
|
|
||||||
'name' => 'redis',
|
|
||||||
'version' => 'latest',
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function addUfw(): void
|
|
||||||
{
|
|
||||||
$this->server->services()->create([
|
|
||||||
'type' => 'firewall',
|
|
||||||
'name' => 'ufw',
|
|
||||||
'version' => 'latest',
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
}
|
@ -13,13 +13,13 @@ 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');
|
})->onQueue('ssh-unique');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,17 +1,22 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace App\Actions\Server;
|
namespace App\Actions\ServerLog;
|
||||||
|
|
||||||
use App\Models\Server;
|
use App\Models\Server;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
class CreateServerLog
|
class CreateLog
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
* @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
|
||||||
{
|
{
|
||||||
|
Validator::make($input, self::rules())->validate();
|
||||||
|
|
||||||
$server->logs()->create([
|
$server->logs()->create([
|
||||||
'is_remote' => true,
|
'is_remote' => true,
|
||||||
'name' => $input['path'],
|
'name' => $input['path'],
|
||||||
@ -20,6 +25,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 [
|
34
app/Actions/ServerLog/UpdateLog.php
Executable file
34
app/Actions/ServerLog/UpdateLog.php
Executable file
@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Actions\ServerLog;
|
||||||
|
|
||||||
|
use App\Models\ServerLog;
|
||||||
|
use Illuminate\Support\Facades\Validator;
|
||||||
|
use Illuminate\Validation\ValidationException;
|
||||||
|
|
||||||
|
class UpdateLog
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $input
|
||||||
|
*
|
||||||
|
* @throws ValidationException
|
||||||
|
*/
|
||||||
|
public function update(ServerLog $serverLog, array $input): void
|
||||||
|
{
|
||||||
|
Validator::make($input, self::rules())->validate();
|
||||||
|
|
||||||
|
$serverLog->update([
|
||||||
|
'name' => $input['path'],
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array<string, string>
|
||||||
|
*/
|
||||||
|
public static function rules(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'path' => 'required',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user