name: database-users description: '' endpoints: - httpMethods: - GET uri: 'api/projects/{project_id}/servers/{server_id}/database-users' metadata: groupName: database-users groupDescription: '' subgroup: '' subgroupDescription: '' title: list description: 'Get all database users.' 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: 32 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 32 queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"data":[{"id":19,"server_id":1,"username":"graciela37","databases":[],"host":"%","status":"creating","created_at":"2025-04-21T18:40:19.000000Z","updated_at":"2025-04-21T18:40:19.000000Z"},{"id":20,"server_id":1,"username":"vconn","databases":[],"host":"%","status":"creating","created_at":"2025-04-21T18:40:19.000000Z","updated_at":"2025-04-21T18:40:19.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}/database-users' metadata: groupName: database-users groupDescription: '' subgroup: '' subgroupDescription: '' title: create description: 'Create a new 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: 32 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 32 queryParameters: [] cleanQueryParameters: [] bodyParameters: username: name: username description: '' required: true example: consequatur type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] password: name: password description: '' required: true example: 'O[2UZ5ij-e/dl4m{o,' 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: consequatur password: 'O[2UZ5ij-e/dl4m{o,' host: '%' fileParameters: [] responses: - status: 200 content: '{"id":19,"server_id":1,"username":"nolan.jaylan","databases":[],"host":"%","status":"creating","created_at":"2025-04-21T18:40:19.000000Z","updated_at":"2025-04-21T18:40:19.000000Z"}' headers: [] description: '' custom: [] responseFields: [] auth: [] 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: 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: 32 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] databaseUser_id: name: databaseUser_id description: 'The ID of the databaseUser.' required: true example: 17 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 32 databaseUser_id: 17 queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 200 content: '{"id":19,"server_id":1,"username":"carolyne.luettgen","databases":[],"host":"%","status":"creating","created_at":"2025-04-21T18:40:19.000000Z","updated_at":"2025-04-21T18:40:19.000000Z"}' headers: [] description: '' custom: [] responseFields: [] auth: [] 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: 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: 32 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] databaseUser_id: name: databaseUser_id description: 'The ID of the databaseUser.' required: true example: 17 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 32 databaseUser_id: 17 queryParameters: [] cleanQueryParameters: [] bodyParameters: databases: name: databases description: 'Array of database names to link to the user.' required: true example: consequatur type: string enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanBodyParameters: databases: consequatur fileParameters: [] responses: - status: 200 content: '{"id":19,"server_id":1,"username":"carolyne.luettgen","databases":[],"host":"%","status":"creating","created_at":"2025-04-21T18:40:19.000000Z","updated_at":"2025-04-21T18:40:19.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: 32 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] databaseUser_id: name: databaseUser_id description: 'The ID of the databaseUser.' required: true example: 17 type: integer enumValues: [] exampleWasSpecified: false nullable: false custom: [] cleanUrlParameters: project_id: 1 server_id: 32 databaseUser_id: 17 queryParameters: [] cleanQueryParameters: [] bodyParameters: [] cleanBodyParameters: [] fileParameters: [] responses: - status: 204 content: null headers: [] description: '' custom: [] responseFields: [] auth: [] controller: null method: null route: null custom: []