openapi: 3.0.3 info: title: 'API documentation for xxxx' description: 'That is API documentation for xxxx webservice' version: 1.0.0 servers: - url: 'https://fail2band.com' paths: /api/fail2Bans: get: summary: 'Display a listing of the resource.' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 503: description: '' content: text/plain: schema: type: string example: "\n\n \n \n \n\n Service Unavailable\n\n \n \n \n\n \n\n \n \n \n
\n
\n
\n
\n 503
\n\n
\n Upgrade in progress, please retry later
\n
\n
\n
\n \n\n" tags: - '' post: summary: 'Store a newly created resource in storage.' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/api/fail2Bans/{id}': get: summary: 'Display the specified resource.' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 503: description: '' content: text/plain: schema: type: string example: "\n\n \n \n \n\n Service Unavailable\n\n \n \n \n\n \n\n \n \n \n
\n
\n
\n
\n 503
\n\n
\n Upgrade in progress, please retry later
\n
\n
\n
\n \n\n" tags: - '' put: summary: 'Update the specified resource in storage.' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' delete: summary: 'Remove the specified resource from storage.' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: 'The ID of the fail2Ban.' example: 10 required: true schema: type: integer /api/ping: post: summary: 'Check if the server is ready and my token is good' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: text/plain: schema: type: string example: "scenario=\"Operation successful\n{\n \"profile\": {\n \"id\": 3,\n \"firstname\": \"john\",\n \"name\": \"doe\",\n \"email\": \"john.doe@utptosign.ext\",\n \"email_verified_at\": null,\n \"language_code_id\": null,\n \"mobile\": \"+33698744401\",\n \"created_at\": \"2022-06-15T05:47:36.000000Z\",\n \"updated_at\": \"2022-06-15T21:23:24.000000Z\",\n \"deleted_at\": null\n },\n \"message\": \"server is ready\",\n \"status\": 1\n}" tags: - 'Login/Logout management' /api/profile: post: summary: 'Get user profile' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - 'Login/Logout management' tags: - name: '' description: '' - name: 'Login/Logout management' description: "\nAPIs for managing auth process" components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []