panel/spec/admin/swagger.yaml at cf21fd5a4b8c828290284dd34847b250b16ff0fc · ghzhost/panel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
swagger: "2.0"
info:
  version: 1.0.0
  title: Pterodactyl Admin API Reference
  description: Pterodactyl Panel API Documentation
  contact:
    name: Dane Everitt
    url: https://pterodactyl.io
    email: support@pterodactyl.io
  license:
    name: MIT
host: example.com
basePath: /api/admin
schemes:
  - http
  - https
consumes:
  - application/vnd.pterodactyl.v1+json
produces:
  - application/json
paths:
  /users:
    get:
      description: |
       Returns all users that exist on the Panel.
      operationId: findUsers
      responses:
        "200":
          description: OK
          schema:
            type: object
            required: ["data"]
            properties:
              data:
                type: array
                items:
                  $ref: '#/definitions/User'
                  properties:
                    id:
                      type: integer
                    attributes:
                      type: object
definitions:
  User:
    allOf:
      - required:
        - email
        - username
        - uuid
        properties:
          external_id:
            type: string
          uuid:
            type: string
          email:
            type: string
          username:
            type: string
          name_first:
            type: string
          name_last:
            type: string
          language:
            type: string
          root_admin:
            type: boolean
          use_totp:
            type: boolean
          updated_at:
            type: string
          created_at:
            type: string