## Autogenerated by Scribe. DO NOT MODIFY. name: servers description: '' endpoints: - httpMethods: - GET uri: 'api/projects/{project_id}/servers' metadata: groupName: servers groupDescription: '' subgroup: '' subgroupDescription: '' title: list description: 'Get all servers in a 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: 200 content: '{"data":[{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Dorthy Toy","ssh_user":"vito","ip":"172.132.95.155","local_ip":"118.57.197.65","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":"Carrie Sporer","ssh_user":"vito","ip":"184.242.162.173","local_ip":"135.244.50.22","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}}' headers: [] description: '' custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer 8VE41PdZcvb6kgafD635ahe' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/projects/{project_id}/servers' metadata: groupName: servers groupDescription: '' subgroup: '' subgroupDescription: '' title: create description: 'Create a new 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: [] cleanUrlParameters: project_id: 1 queryParameters: [] cleanQueryParameters: [] bodyParameters: provider: name: provider description: 'The server provider type' required: true example: et type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] server_provider: name: server_provider description: 'If the provider is not custom, the ID of the server provider profile' required: true example: digitalocean type: string enumValues: - custom - hetzner - digitalocean - linode - vultr exampleWasSpecified: false nullable: false custom: [] region: name: region description: 'Provider region if the provider is not custom' required: true example: inventore type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] plan: name: plan description: 'Provider plan if the provider is not custom' required: true example: atque type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] ip: name: ip description: 'SSH IP address if the provider is custom' required: true example: quam type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] port: name: port description: 'SSH Port if the provider is custom' required: true example: nemo type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] name: name: name description: 'The name of the server.' required: true example: perspiciatis type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] os: name: os description: 'The os of the server' required: true example: similique type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] type: name: type description: 'Server type' required: true example: regular type: string enumValues: - regular - database 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: none 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.1' 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: provider: et server_provider: digitalocean region: inventore plan: atque ip: quam port: nemo name: perspiciatis os: similique type: regular webserver: none database: none php: '8.1' fileParameters: [] responses: - status: 200 content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Flo Beer PhD","ssh_user":"vito","ip":"168.238.14.230","local_ip":"40.232.73.41","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}' headers: [] description: '' custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer Z8g36aaV4E1bdcPfehDv65k' controller: null method: null route: null custom: [] - httpMethods: - GET uri: 'api/projects/{project_id}/servers/{id}' metadata: groupName: servers groupDescription: '' subgroup: '' subgroupDescription: '' title: show description: 'Get a server by ID.' authenticated: true custom: [] headers: Authorization: 'Bearer YOUR-API-KEY' Content-Type: application/json Accept: application/json urlParameters: project_id: name: project_id description: 'The ID of the project.' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] id: name: id description: 'The ID of the server.' required: true example: 3 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 id: 3 queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"id":null,"project_id":null,"user_id":null,"provider_id":null,"name":"Stephany Ankunding","ssh_user":"vito","ip":"145.28.94.46","local_ip":"69.133.44.100","port":22,"os":"ubuntu_22","type":"regular","type_data":null,"provider":"custom","provider_data":null,"public_key":"test","status":"ready","auto_update":null,"available_updates":0,"security_updates":null,"progress":100,"progress_step":null,"updates":null,"last_update_check":null,"created_at":null,"updated_at":null}' headers: [] description: '' custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer adD3EfP5hZ4vgbkV861eca6' controller: null method: null route: null custom: [] - httpMethods: - POST uri: 'api/projects/{project_id}/servers/{server_id}/reboot' metadata: groupName: servers groupDescription: '' subgroup: '' subgroupDescription: '' title: reboot description: 'Reboot a server.' authenticated: true custom: [] headers: Authorization: 'Bearer YOUR-API-KEY' Content-Type: application/json Accept: application/json urlParameters: project_id: name: project_id description: 'The ID of the project.' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] server_id: name: server_id description: 'The ID of the server.' required: true example: 3 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 3 queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 204 content: 'null' headers: [] description: '' custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer P3ec6aagD4hbdV5fEk168vZ' 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: 3 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 3 queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 204 content: 'null' headers: [] description: '' custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer P34ZV6D1bEegdvac8f5kh6a' controller: null method: null route: null custom: [] - httpMethods: - DELETE uri: 'api/projects/{project_id}/servers/{server_id}' metadata: groupName: servers groupDescription: '' subgroup: '' subgroupDescription: '' title: delete description: 'Delete server.' authenticated: true custom: [] headers: Authorization: 'Bearer YOUR-API-KEY' Content-Type: application/json Accept: application/json urlParameters: project_id: name: project_id description: 'The ID of the project.' required: true example: 1 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] server_id: name: server_id description: 'The ID of the server.' required: true example: 3 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 3 queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 204 content: 'null' headers: [] description: '' custom: [] responseFields: [] auth: - headers - Authorization - 'Bearer ha6v5V41afkdPgcZbDEe386' controller: null method: null route: null custom: []