Dashboard Data Api

Hosted at 0.0.0.0:7777

/gitlab

GET /gitlab/projects

Returns a List of all Gitlab Projects

Response

[   {   'archived': <class 'bool'>,
        'avatar': <class 'str'>,
        'branches': [   <class 'str'>],
        'description': <class 'str'>,
        'id': <class 'int'>,
        'name': <class 'str'>,
        'namespace': {   'avatar': <class 'str'>,
                         'full_path': <class 'str'>,
                         'id': <class 'int'>,
                         'kind': <class 'str'>,
                         'name': <class 'str'>,
                         'path': <class 'str'>,
                         'url': <class 'str'>},
        'path': <class 'str'>,
        'pipelines': [   {   'created_at': <class 'str'>,
                             'id': <class 'int'>,
                             'jobs': [   {   'author': <class 'str'>,
                                             'author_image_url': <class 'str'>,
                                             'author_url': <class 'str'>,
                                             'commit_message': <class 'str'>,
                                             'commit_title': <class 'str'>,
                                             'commit_url': <class 'str'>,
                                             'created_at': <class 'str'>,
                                             'duration': <class 'float'>,
                                             'finished_at': <class 'str'>,
                                             'id': <class 'int'>,
                                             'name': <class 'str'>,
                                             'ref': <class 'str'>,
                                             'stage': <class 'str'>,
                                             'started_at': <class 'str'>,
                                             'status': <enum 'JobStatus'>,
                                             'url': <class 'str'>}],
                             'project_id': <class 'int'>,
                             'ref': <class 'str'>,
                             'sha': <class 'str'>,
                             'status': <class 'str'>,
                             'updated_at': <class 'str'>,
                             'web_url': <class 'str'>}],
        'protected_branches': [   <class 'str'>],
        'releases': [   {   'created_at': <class 'str'>,
                            'description': <class 'str'>,
                            'milestones': [   typing.Dict[str, typing.Any]],
                            'name': <class 'str'>,
                            'released_at': <class 'str'>,
                            'tag_name': <class 'str'>}],
        'url': <class 'str'>}]

GET /gitlab/projects/<namespace:path>/<path:re:[0-9a-z_\-\.]+>/readme

Retrieves current master readme file

Response

<class 'str'>

GET /gitlab/projects/<project_id:int>/readme

Retrieves current master readme file

Response

<class 'str'>

GET /gitlab/projects/<namespace:path>/<path:re:[0-9a-z_\-\.]+>

Returns a Gitlab Project with all Details

Response

{   'archived': <class 'bool'>,
    'avatar': <class 'str'>,
    'branches': [   <class 'str'>],
    'description': <class 'str'>,
    'id': <class 'int'>,
    'jobs': [   {   'author': <class 'str'>,
                    'author_image_url': <class 'str'>,
                    'author_url': <class 'str'>,
                    'commit_message': <class 'str'>,
                    'commit_title': <class 'str'>,
                    'commit_url': <class 'str'>,
                    'created_at': <class 'str'>,
                    'duration': <class 'float'>,
                    'finished_at': <class 'str'>,
                    'id': <class 'int'>,
                    'name': <class 'str'>,
                    'ref': <class 'str'>,
                    'stage': <class 'str'>,
                    'started_at': <class 'str'>,
                    'status': <enum 'JobStatus'>,
                    'url': <class 'str'>}],
    'name': <class 'str'>,
    'namespace': {   'avatar': <class 'str'>,
                     'full_path': <class 'str'>,
                     'id': <class 'int'>,
                     'kind': <class 'str'>,
                     'name': <class 'str'>,
                     'path': <class 'str'>,
                     'url': <class 'str'>},
    'path': <class 'str'>,
    'pipelines': [   {   'created_at': <class 'str'>,
                         'id': <class 'int'>,
                         'jobs': [   {   'author': <class 'str'>,
                                         'author_image_url': <class 'str'>,
                                         'author_url': <class 'str'>,
                                         'commit_message': <class 'str'>,
                                         'commit_title': <class 'str'>,
                                         'commit_url': <class 'str'>,
                                         'created_at': <class 'str'>,
                                         'duration': <class 'float'>,
                                         'finished_at': <class 'str'>,
                                         'id': <class 'int'>,
                                         'name': <class 'str'>,
                                         'ref': <class 'str'>,
                                         'stage': <class 'str'>,
                                         'started_at': <class 'str'>,
                                         'status': <enum 'JobStatus'>,
                                         'url': <class 'str'>}],
                         'project_id': <class 'int'>,
                         'ref': <class 'str'>,
                         'sha': <class 'str'>,
                         'status': <class 'str'>,
                         'updated_at': <class 'str'>,
                         'web_url': <class 'str'>}],
    'plones': [   {   'cmf_version': <class 'str'>,
                      'debug_mode': <class 'str'>,
                      'domain': <class 'str'>,
                      'favicon': (   <class 'str'>,
                                     <class 'NoneType'>),
                      'id': <class 'int'>,
                      'master_plone_template_version': <class 'str'>,
                      'name': <class 'str'>,
                      'nodejs_version': <class 'str'>,
                      'npm_version': <class 'str'>,
                      'os': <class 'str'>,
                      'os_version': <class 'str'>,
                      'pil_version': <class 'str'>,
                      'plone_version': <class 'str'>,
                      'python_version': <class 'str'>,
                      'repository_branch': <class 'str'>,
                      'repository_name': <class 'str'>,
                      'repository_namespace': <class 'str'>,
                      'server': (   {   'cpu_cores': <class 'int'>,
                                        'cpu_cores_per_sockets': <class 'int'>,
                                        'cpu_frequency': <class 'float'>,
                                        'cpu_name': <class 'str'>,
                                        'cpu_sockets': <class 'int'>,
                                        'deactivated': <class 'bool'>,
                                        'deactivated_reason': <class 'str'>,
                                        'distribution': <class 'str'>,
                                        'distribution_version': <class 'str'>,
                                        'fqdn': <class 'str'>,
                                        'hoster': <enum 'ServerHoster'>,
                                        'hostname': <class 'str'>,
                                        'id': <class 'int'>,
                                        'kernel': <class 'str'>,
                                        'kernel_version': <class 'str'>,
                                        'node': <class 'str'>,
                                        'npm': <class 'str'>,
                                        'python2': <class 'str'>,
                                        'python3': <class 'str'>,
                                        'start_time': <class 'datetime.datetime'>,
                                        'system_memory': <class 'int'>,
                                        'updated_at': <class 'datetime.datetime'>,
                                        'yarn': <class 'str'>},
                                    <class 'NoneType'>),
                      'tiles_version': <class 'str'>,
                      'update_warranty': <class 'bool'>,
                      'updated_at': <class 'str'>,
                      'zope_version': <class 'str'>}],
    'protected_branches': [   <class 'str'>],
    'releases': [   {   'created_at': <class 'str'>,
                        'description': <class 'str'>,
                        'milestones': [   typing.Dict[str, typing.Any]],
                        'name': <class 'str'>,
                        'released_at': <class 'str'>,
                        'tag_name': <class 'str'>}],
    'url': <class 'str'>}

GET /gitlab/projects/<project_id:int>

Returns a Gitlab Project with all Details

Response

{   'archived': <class 'bool'>,
    'avatar': <class 'str'>,
    'branches': [   <class 'str'>],
    'description': <class 'str'>,
    'id': <class 'int'>,
    'jobs': [   {   'author': <class 'str'>,
                    'author_image_url': <class 'str'>,
                    'author_url': <class 'str'>,
                    'commit_message': <class 'str'>,
                    'commit_title': <class 'str'>,
                    'commit_url': <class 'str'>,
                    'created_at': <class 'str'>,
                    'duration': <class 'float'>,
                    'finished_at': <class 'str'>,
                    'id': <class 'int'>,
                    'name': <class 'str'>,
                    'ref': <class 'str'>,
                    'stage': <class 'str'>,
                    'started_at': <class 'str'>,
                    'status': <enum 'JobStatus'>,
                    'url': <class 'str'>}],
    'name': <class 'str'>,
    'namespace': {   'avatar': <class 'str'>,
                     'full_path': <class 'str'>,
                     'id': <class 'int'>,
                     'kind': <class 'str'>,
                     'name': <class 'str'>,
                     'path': <class 'str'>,
                     'url': <class 'str'>},
    'path': <class 'str'>,
    'pipelines': [   {   'created_at': <class 'str'>,
                         'id': <class 'int'>,
                         'jobs': [   {   'author': <class 'str'>,
                                         'author_image_url': <class 'str'>,
                                         'author_url': <class 'str'>,
                                         'commit_message': <class 'str'>,
                                         'commit_title': <class 'str'>,
                                         'commit_url': <class 'str'>,
                                         'created_at': <class 'str'>,
                                         'duration': <class 'float'>,
                                         'finished_at': <class 'str'>,
                                         'id': <class 'int'>,
                                         'name': <class 'str'>,
                                         'ref': <class 'str'>,
                                         'stage': <class 'str'>,
                                         'started_at': <class 'str'>,
                                         'status': <enum 'JobStatus'>,
                                         'url': <class 'str'>}],
                         'project_id': <class 'int'>,
                         'ref': <class 'str'>,
                         'sha': <class 'str'>,
                         'status': <class 'str'>,
                         'updated_at': <class 'str'>,
                         'web_url': <class 'str'>}],
    'plones': [   {   'cmf_version': <class 'str'>,
                      'debug_mode': <class 'str'>,
                      'domain': <class 'str'>,
                      'favicon': (   <class 'str'>,
                                     <class 'NoneType'>),
                      'id': <class 'int'>,
                      'master_plone_template_version': <class 'str'>,
                      'name': <class 'str'>,
                      'nodejs_version': <class 'str'>,
                      'npm_version': <class 'str'>,
                      'os': <class 'str'>,
                      'os_version': <class 'str'>,
                      'pil_version': <class 'str'>,
                      'plone_version': <class 'str'>,
                      'python_version': <class 'str'>,
                      'repository_branch': <class 'str'>,
                      'repository_name': <class 'str'>,
                      'repository_namespace': <class 'str'>,
                      'server': (   {   'cpu_cores': <class 'int'>,
                                        'cpu_cores_per_sockets': <class 'int'>,
                                        'cpu_frequency': <class 'float'>,
                                        'cpu_name': <class 'str'>,
                                        'cpu_sockets': <class 'int'>,
                                        'deactivated': <class 'bool'>,
                                        'deactivated_reason': <class 'str'>,
                                        'distribution': <class 'str'>,
                                        'distribution_version': <class 'str'>,
                                        'fqdn': <class 'str'>,
                                        'hoster': <enum 'ServerHoster'>,
                                        'hostname': <class 'str'>,
                                        'id': <class 'int'>,
                                        'kernel': <class 'str'>,
                                        'kernel_version': <class 'str'>,
                                        'node': <class 'str'>,
                                        'npm': <class 'str'>,
                                        'python2': <class 'str'>,
                                        'python3': <class 'str'>,
                                        'start_time': <class 'datetime.datetime'>,
                                        'system_memory': <class 'int'>,
                                        'updated_at': <class 'datetime.datetime'>,
                                        'yarn': <class 'str'>},
                                    <class 'NoneType'>),
                      'tiles_version': <class 'str'>,
                      'update_warranty': <class 'bool'>,
                      'updated_at': <class 'str'>,
                      'zope_version': <class 'str'>}],
    'protected_branches': [   <class 'str'>],
    'releases': [   {   'created_at': <class 'str'>,
                        'description': <class 'str'>,
                        'milestones': [   typing.Dict[str, typing.Any]],
                        'name': <class 'str'>,
                        'released_at': <class 'str'>,
                        'tag_name': <class 'str'>}],
    'url': <class 'str'>}

GET /gitlab/runners

Not Documented

Response

[   {   'active': <class 'bool'>,
        'id': <class 'int'>,
        'ip': <class 'str'>,
        'is_shared': <class 'bool'>,
        'job': (   {   'author': <class 'str'>,
                       'author_image_url': <class 'str'>,
                       'author_url': <class 'str'>,
                       'commit_message': <class 'str'>,
                       'commit_title': <class 'str'>,
                       'commit_url': <class 'str'>,
                       'created_at': <class 'str'>,
                       'duration': <class 'float'>,
                       'finished_at': <class 'str'>,
                       'id': <class 'int'>,
                       'name': <class 'str'>,
                       'pipeline': {   'created_at': <class 'str'>,
                                       'id': <class 'int'>,
                                       'project_id': <class 'int'>,
                                       'ref': <class 'str'>,
                                       'sha': <class 'str'>,
                                       'status': <class 'str'>,
                                       'updated_at': <class 'str'>,
                                       'web_url': <class 'str'>},
                       'ref': <class 'str'>,
                       'stage': <class 'str'>,
                       'started_at': <class 'str'>,
                       'status': <enum 'JobStatus'>,
                       'url': <class 'str'>},
                   <class 'NoneType'>),
        'name': <class 'str'>,
        'online': <class 'bool'>,
        'status': <enum 'RunnerStatus'>}]

GET /gitlab/runners/<runner_id>

Not Documented

Response

{   'active': <class 'bool'>,
    'id': <class 'int'>,
    'ip': <class 'str'>,
    'is_shared': <class 'bool'>,
    'jobs': [   {   'author': <class 'str'>,
                    'author_image_url': <class 'str'>,
                    'author_url': <class 'str'>,
                    'commit_message': <class 'str'>,
                    'commit_title': <class 'str'>,
                    'commit_url': <class 'str'>,
                    'created_at': <class 'str'>,
                    'duration': <class 'float'>,
                    'finished_at': <class 'str'>,
                    'id': <class 'int'>,
                    'name': <class 'str'>,
                    'pipeline': {   'created_at': <class 'str'>,
                                    'id': <class 'int'>,
                                    'project_id': <class 'int'>,
                                    'ref': <class 'str'>,
                                    'sha': <class 'str'>,
                                    'status': <class 'str'>,
                                    'updated_at': <class 'str'>,
                                    'web_url': <class 'str'>},
                    'ref': <class 'str'>,
                    'stage': <class 'str'>,
                    'started_at': <class 'str'>,
                    'status': <enum 'JobStatus'>,
                    'url': <class 'str'>}],
    'name': <class 'str'>,
    'online': <class 'bool'>,
    'status': <enum 'RunnerStatus'>}

/plone

GET /plone/

Get list of all Plones :param db: Database session :param session: User Session

Response

[   {   'cmf_version': <class 'str'>,
        'debug_mode': <class 'str'>,
        'domain': <class 'str'>,
        'favicon': (   <class 'str'>,
                       <class 'NoneType'>),
        'id': <class 'int'>,
        'master_plone_template_version': <class 'str'>,
        'name': <class 'str'>,
        'nodejs_version': <class 'str'>,
        'npm_version': <class 'str'>,
        'os': <class 'str'>,
        'os_version': <class 'str'>,
        'pil_version': <class 'str'>,
        'plone_version': <class 'str'>,
        'python_version': <class 'str'>,
        'repository_branch': <class 'str'>,
        'repository_name': <class 'str'>,
        'repository_namespace': <class 'str'>,
        'server': (   {   'cpu_cores': <class 'int'>,
                          'cpu_cores_per_sockets': <class 'int'>,
                          'cpu_frequency': <class 'float'>,
                          'cpu_name': <class 'str'>,
                          'cpu_sockets': <class 'int'>,
                          'deactivated': <class 'bool'>,
                          'deactivated_reason': <class 'str'>,
                          'distribution': <class 'str'>,
                          'distribution_version': <class 'str'>,
                          'fqdn': <class 'str'>,
                          'hoster': <enum 'ServerHoster'>,
                          'hostname': <class 'str'>,
                          'id': <class 'int'>,
                          'kernel': <class 'str'>,
                          'kernel_version': <class 'str'>,
                          'node': <class 'str'>,
                          'npm': <class 'str'>,
                          'python2': <class 'str'>,
                          'python3': <class 'str'>,
                          'start_time': <class 'datetime.datetime'>,
                          'system_memory': <class 'int'>,
                          'updated_at': <class 'datetime.datetime'>,
                          'yarn': <class 'str'>},
                      <class 'NoneType'>),
        'tiles_version': <class 'str'>,
        'update_warranty': <class 'bool'>,
        'updated_at': <class 'str'>,
        'zope_version': <class 'str'>}]

GET /plone/<plone_id>

Get details of Plone installation. :param db: Database session :param session: User session :param plone_id: Can be Plone ID or Plone Domain

Response

{   'addons': [   {   'id': <class 'str'>,
                      'name': <class 'str'>,
                      'status': <enum 'PloneAddonInstallationStatus'>,
                      'version': <class 'str'>}],
    'cmf_version': <class 'str'>,
    'debug_mode': <class 'str'>,
    'domain': <class 'str'>,
    'eggs': [   {   'id': <class 'int'>,
                    'name': <class 'str'>,
                    'version': <class 'str'>}],
    'favicon': (   <class 'str'>,
                   <class 'NoneType'>),
    'id': <class 'int'>,
    'master_plone_template_version': <class 'str'>,
    'name': <class 'str'>,
    'nodejs_version': <class 'str'>,
    'npm_packages': [   ForwardRef('TPackageData')],
    'npm_version': <class 'str'>,
    'os': <class 'str'>,
    'os_version': <class 'str'>,
    'pil_version': <class 'str'>,
    'plone_version': <class 'str'>,
    'python_version': <class 'str'>,
    'repository_branch': <class 'str'>,
    'repository_name': <class 'str'>,
    'repository_namespace': <class 'str'>,
    'server': (   {   'cpu_cores': <class 'int'>,
                      'cpu_cores_per_sockets': <class 'int'>,
                      'cpu_frequency': <class 'float'>,
                      'cpu_name': <class 'str'>,
                      'cpu_sockets': <class 'int'>,
                      'deactivated': <class 'bool'>,
                      'deactivated_reason': <class 'str'>,
                      'distribution': <class 'str'>,
                      'distribution_version': <class 'str'>,
                      'fqdn': <class 'str'>,
                      'hoster': <enum 'ServerHoster'>,
                      'hostname': <class 'str'>,
                      'id': <class 'int'>,
                      'kernel': <class 'str'>,
                      'kernel_version': <class 'str'>,
                      'node': <class 'str'>,
                      'npm': <class 'str'>,
                      'python2': <class 'str'>,
                      'python3': <class 'str'>,
                      'start_time': <class 'datetime.datetime'>,
                      'system_memory': <class 'int'>,
                      'updated_at': <class 'datetime.datetime'>,
                      'yarn': <class 'str'>},
                  <class 'NoneType'>),
    'update_warranty': <class 'bool'>,
    'updated_at': <class 'str'>,
    'zope_version': <class 'str'>}

PUT /plone/<plone_id>/update_favicon

call to explicit refetch favicon for Plone entry :param db: Database session :param session: User session :param plone_id: Can be Plone ID or Plone Domain

Response

<class 'bool'>

PUT /plone/<plone_id>/update_settings

call to update plone settings from modal :param db: Database session :param session: User session :param plone_id: Can be Plone ID or Plone Domain

Response

{   'addons': [   {   'id': <class 'str'>,
                      'name': <class 'str'>,
                      'status': <enum 'PloneAddonInstallationStatus'>,
                      'version': <class 'str'>}],
    'cmf_version': <class 'str'>,
    'debug_mode': <class 'str'>,
    'domain': <class 'str'>,
    'eggs': [   {   'id': <class 'int'>,
                    'name': <class 'str'>,
                    'version': <class 'str'>}],
    'favicon': (   <class 'str'>,
                   <class 'NoneType'>),
    'id': <class 'int'>,
    'master_plone_template_version': <class 'str'>,
    'name': <class 'str'>,
    'nodejs_version': <class 'str'>,
    'npm_packages': [   ForwardRef('TPackageData')],
    'npm_version': <class 'str'>,
    'os': <class 'str'>,
    'os_version': <class 'str'>,
    'pil_version': <class 'str'>,
    'plone_version': <class 'str'>,
    'python_version': <class 'str'>,
    'repository_branch': <class 'str'>,
    'repository_name': <class 'str'>,
    'repository_namespace': <class 'str'>,
    'server': (   {   'cpu_cores': <class 'int'>,
                      'cpu_cores_per_sockets': <class 'int'>,
                      'cpu_frequency': <class 'float'>,
                      'cpu_name': <class 'str'>,
                      'cpu_sockets': <class 'int'>,
                      'deactivated': <class 'bool'>,
                      'deactivated_reason': <class 'str'>,
                      'distribution': <class 'str'>,
                      'distribution_version': <class 'str'>,
                      'fqdn': <class 'str'>,
                      'hoster': <enum 'ServerHoster'>,
                      'hostname': <class 'str'>,
                      'id': <class 'int'>,
                      'kernel': <class 'str'>,
                      'kernel_version': <class 'str'>,
                      'node': <class 'str'>,
                      'npm': <class 'str'>,
                      'python2': <class 'str'>,
                      'python3': <class 'str'>,
                      'start_time': <class 'datetime.datetime'>,
                      'system_memory': <class 'int'>,
                      'updated_at': <class 'datetime.datetime'>,
                      'yarn': <class 'str'>},
                  <class 'NoneType'>),
    'update_warranty': <class 'bool'>,
    'updated_at': <class 'str'>,
    'zope_version': <class 'str'>}

POST /plone/update_plone

Not Documented

Response

None

/server

GET /server/

Not Documented

Response

[   {   'cpu_cores': <class 'int'>,
        'cpu_cores_per_sockets': <class 'int'>,
        'cpu_frequency': <class 'float'>,
        'cpu_name': <class 'str'>,
        'cpu_sockets': <class 'int'>,
        'deactivated': <class 'bool'>,
        'deactivated_reason': <class 'str'>,
        'distribution': <class 'str'>,
        'distribution_version': <class 'str'>,
        'fqdn': <class 'str'>,
        'hoster': <enum 'ServerHoster'>,
        'hostname': <class 'str'>,
        'id': <class 'int'>,
        'kernel': <class 'str'>,
        'kernel_version': <class 'str'>,
        'node': <class 'str'>,
        'npm': <class 'str'>,
        'python2': <class 'str'>,
        'python3': <class 'str'>,
        'start_time': <class 'datetime.datetime'>,
        'system_memory': <class 'int'>,
        'updated_at': <class 'datetime.datetime'>,
        'yarn': <class 'str'>}]

GET /server/<server_id>

Get details of Server. server_id - Can be server ID or hostname

Response

{   'cpu_cores': <class 'int'>,
    'cpu_cores_per_sockets': <class 'int'>,
    'cpu_frequency': <class 'float'>,
    'cpu_name': <class 'str'>,
    'cpu_sockets': <class 'int'>,
    'deactivated': <class 'bool'>,
    'deactivated_reason': <class 'str'>,
    'distribution': <class 'str'>,
    'distribution_version': <class 'str'>,
    'fqdn': <class 'str'>,
    'hoster': <enum 'ServerHoster'>,
    'hostname': <class 'str'>,
    'id': <class 'int'>,
    'kernel': <class 'str'>,
    'kernel_version': <class 'str'>,
    'node': <class 'str'>,
    'npm': <class 'str'>,
    'plones': [   {   'cmf_version': <class 'str'>,
                      'deactivated': <class 'bool'>,
                      'deactivated_reason': <class 'str'>,
                      'debug_mode': <class 'str'>,
                      'domain': <class 'str'>,
                      'favicon': (   <class 'str'>,
                                     <class 'NoneType'>),
                      'id': <class 'int'>,
                      'master_plone_template_version': <class 'str'>,
                      'name': <class 'str'>,
                      'nodejs_version': <class 'str'>,
                      'npm_version': <class 'str'>,
                      'os': <class 'str'>,
                      'os_version': <class 'str'>,
                      'pil_version': <class 'str'>,
                      'plone_version': <class 'str'>,
                      'python_version': <class 'str'>,
                      'repository_branch': <class 'str'>,
                      'repository_name': <class 'str'>,
                      'repository_namespace': <class 'str'>,
                      'tiles_version': <class 'str'>,
                      'update_warranty': <class 'bool'>,
                      'updated_at': <class 'str'>,
                      'zope_version': <class 'str'>}],
    'python2': <class 'str'>,
    'python3': <class 'str'>,
    'start_time': <class 'datetime.datetime'>,
    'system_memory': <class 'int'>,
    'updated_at': <class 'datetime.datetime'>,
    'yarn': <class 'str'>}

PUT /server/<server_id>

call to update server settings from modal :param db: Database session :param session: User session :param server_id: can be Server ID or Hostname

Response

{   'cpu_cores': <class 'int'>,
    'cpu_cores_per_sockets': <class 'int'>,
    'cpu_frequency': <class 'float'>,
    'cpu_name': <class 'str'>,
    'cpu_sockets': <class 'int'>,
    'deactivated': <class 'bool'>,
    'deactivated_reason': <class 'str'>,
    'distribution': <class 'str'>,
    'distribution_version': <class 'str'>,
    'fqdn': <class 'str'>,
    'hoster': <enum 'ServerHoster'>,
    'hostname': <class 'str'>,
    'id': <class 'int'>,
    'kernel': <class 'str'>,
    'kernel_version': <class 'str'>,
    'node': <class 'str'>,
    'npm': <class 'str'>,
    'plones': [   {   'cmf_version': <class 'str'>,
                      'deactivated': <class 'bool'>,
                      'deactivated_reason': <class 'str'>,
                      'debug_mode': <class 'str'>,
                      'domain': <class 'str'>,
                      'favicon': (   <class 'str'>,
                                     <class 'NoneType'>),
                      'id': <class 'int'>,
                      'master_plone_template_version': <class 'str'>,
                      'name': <class 'str'>,
                      'nodejs_version': <class 'str'>,
                      'npm_version': <class 'str'>,
                      'os': <class 'str'>,
                      'os_version': <class 'str'>,
                      'pil_version': <class 'str'>,
                      'plone_version': <class 'str'>,
                      'python_version': <class 'str'>,
                      'repository_branch': <class 'str'>,
                      'repository_name': <class 'str'>,
                      'repository_namespace': <class 'str'>,
                      'tiles_version': <class 'str'>,
                      'update_warranty': <class 'bool'>,
                      'updated_at': <class 'str'>,
                      'zope_version': <class 'str'>}],
    'python2': <class 'str'>,
    'python3': <class 'str'>,
    'start_time': <class 'datetime.datetime'>,
    'system_memory': <class 'int'>,
    'updated_at': <class 'datetime.datetime'>,
    'yarn': <class 'str'>}

POST /server/update_server

Not Documented

Response

None

/user

POST /user/login

Creates a New Session for given the User with correctly supplied password

Response

{   'avatar': (   <class 'str'>,
                  <class 'NoneType'>),
    'email': <class 'str'>,
    'gitlab': (   <class 'str'>,
                  <class 'NoneType'>),
    'id': <class 'int'>,
    'name': <class 'str'>,
    'permissions': typing.Dict[str, bool],
    'redmine': (   <class 'str'>,
                   <class 'NoneType'>),
    'registered': (   <class 'str'>,
                      <class 'NoneType'>),
    'sentry': (   <class 'str'>,
                  <class 'NoneType'>),
    'session': <class 'str'>,
    'slack': (   <class 'str'>,
                 <class 'NoneType'>)}

POST /user/validate_session

Validates a Session and supplies the User data when correct

Response

{   'avatar': (   <class 'str'>,
                  <class 'NoneType'>),
    'email': <class 'str'>,
    'gitlab': (   <class 'str'>,
                  <class 'NoneType'>),
    'id': <class 'int'>,
    'name': <class 'str'>,
    'permissions': typing.Dict[str, bool],
    'redmine': (   <class 'str'>,
                   <class 'NoneType'>),
    'registered': (   <class 'str'>,
                      <class 'NoneType'>),
    'sentry': (   <class 'str'>,
                  <class 'NoneType'>),
    'session': <class 'str'>,
    'slack': (   <class 'str'>,
                 <class 'NoneType'>)}

GET /user/logout

Removes a valid Session

Response

<class 'bool'>

GET /user/all

List of all User in the System

Response

[   {   'avatar': (   <class 'str'>,
                      <class 'NoneType'>),
        'deactivated': (   <class 'bool'>,
                           <class 'NoneType'>),
        'deactivated_reason': (   <class 'str'>,
                                  <class 'NoneType'>),
        'email': <class 'str'>,
        'gitlab': (   <class 'str'>,
                      <class 'NoneType'>),
        'id': <class 'int'>,
        'last_seen': (   <class 'str'>,
                         <class 'NoneType'>),
        'name': <class 'str'>,
        'permissions': (   {   'add_user': ForwardRef('bool'),
                               'edit_plone': ForwardRef('Union[bool, List[int]]'),
                               'edit_server': ForwardRef('Union[bool, List[int]]'),
                               'remove_user': ForwardRef('bool'),
                               'update_user': ForwardRef('bool'),
                               'view_gitlab': ForwardRef('Union[bool, List[int]]'),
                               'view_gitlab_runner': ForwardRef('bool'),
                               'view_plone': ForwardRef('Union[bool, List[int]]'),
                               'view_server': ForwardRef('Union[bool, List[int]]'),
                               'view_user': ForwardRef('bool')},
                           <class 'NoneType'>),
        'redmine': (   <class 'str'>,
                       <class 'NoneType'>),
        'registered': (   <class 'str'>,
                          <class 'NoneType'>),
        'sentry': (   <class 'str'>,
                      <class 'NoneType'>),
        'slack': (   <class 'str'>,
                     <class 'NoneType'>)}]

POST /user/add

Adds a new User to the System

Response

{   'avatar': (   <class 'str'>,
                  <class 'NoneType'>),
    'deactivated': (   <class 'bool'>,
                       <class 'NoneType'>),
    'deactivated_reason': (   <class 'str'>,
                              <class 'NoneType'>),
    'email': <class 'str'>,
    'gitlab': (   <class 'str'>,
                  <class 'NoneType'>),
    'id': <class 'int'>,
    'last_seen': (   <class 'str'>,
                     <class 'NoneType'>),
    'name': <class 'str'>,
    'permissions': (   {   'add_user': ForwardRef('bool'),
                           'edit_plone': ForwardRef('Union[bool, List[int]]'),
                           'edit_server': ForwardRef('Union[bool, List[int]]'),
                           'remove_user': ForwardRef('bool'),
                           'update_user': ForwardRef('bool'),
                           'view_gitlab': ForwardRef('Union[bool, List[int]]'),
                           'view_gitlab_runner': ForwardRef('bool'),
                           'view_plone': ForwardRef('Union[bool, List[int]]'),
                           'view_server': ForwardRef('Union[bool, List[int]]'),
                           'view_user': ForwardRef('bool')},
                       <class 'NoneType'>),
    'redmine': (   <class 'str'>,
                   <class 'NoneType'>),
    'registered': (   <class 'str'>,
                      <class 'NoneType'>),
    'sentry': (   <class 'str'>,
                  <class 'NoneType'>),
    'slack': (   <class 'str'>,
                 <class 'NoneType'>)}

DELETE /user/<user_id>

Deletes a User in the System

Response

<class 'bool'>

GET /user/<user_id>

View a User in the System

Response

{   'avatar': (   <class 'str'>,
                  <class 'NoneType'>),
    'deactivated': (   <class 'bool'>,
                       <class 'NoneType'>),
    'deactivated_reason': (   <class 'str'>,
                              <class 'NoneType'>),
    'email': <class 'str'>,
    'gitlab': (   <class 'str'>,
                  <class 'NoneType'>),
    'id': <class 'int'>,
    'last_seen': (   <class 'str'>,
                     <class 'NoneType'>),
    'name': <class 'str'>,
    'permissions': (   {   'add_user': ForwardRef('bool'),
                           'edit_plone': ForwardRef('Union[bool, List[int]]'),
                           'edit_server': ForwardRef('Union[bool, List[int]]'),
                           'remove_user': ForwardRef('bool'),
                           'update_user': ForwardRef('bool'),
                           'view_gitlab': ForwardRef('Union[bool, List[int]]'),
                           'view_gitlab_runner': ForwardRef('bool'),
                           'view_plone': ForwardRef('Union[bool, List[int]]'),
                           'view_server': ForwardRef('Union[bool, List[int]]'),
                           'view_user': ForwardRef('bool')},
                       <class 'NoneType'>),
    'redmine': (   <class 'str'>,
                   <class 'NoneType'>),
    'registered': (   <class 'str'>,
                      <class 'NoneType'>),
    'sentry': (   <class 'str'>,
                  <class 'NoneType'>),
    'slack': (   <class 'str'>,
                 <class 'NoneType'>)}

PUT /user/<user_id>

Updates a User in the System If email is provided, password is required

Response

{   'avatar': (   <class 'str'>,
                  <class 'NoneType'>),
    'deactivated': (   <class 'bool'>,
                       <class 'NoneType'>),
    'deactivated_reason': (   <class 'str'>,
                              <class 'NoneType'>),
    'email': <class 'str'>,
    'gitlab': (   <class 'str'>,
                  <class 'NoneType'>),
    'id': <class 'int'>,
    'last_seen': (   <class 'str'>,
                     <class 'NoneType'>),
    'name': <class 'str'>,
    'permissions': (   {   'add_user': ForwardRef('bool'),
                           'edit_plone': ForwardRef('Union[bool, List[int]]'),
                           'edit_server': ForwardRef('Union[bool, List[int]]'),
                           'remove_user': ForwardRef('bool'),
                           'update_user': ForwardRef('bool'),
                           'view_gitlab': ForwardRef('Union[bool, List[int]]'),
                           'view_gitlab_runner': ForwardRef('bool'),
                           'view_plone': ForwardRef('Union[bool, List[int]]'),
                           'view_server': ForwardRef('Union[bool, List[int]]'),
                           'view_user': ForwardRef('bool')},
                       <class 'NoneType'>),
    'redmine': (   <class 'str'>,
                   <class 'NoneType'>),
    'registered': (   <class 'str'>,
                      <class 'NoneType'>),
    'sentry': (   <class 'str'>,
                  <class 'NoneType'>),
    'slack': (   <class 'str'>,
                 <class 'NoneType'>)}

PUT /user/update_profile

Updates the profile of currently logged-in User in the System. Can't update password or email of User

Response

{   'avatar': (   <class 'str'>,
                  <class 'NoneType'>),
    'deactivated': (   <class 'bool'>,
                       <class 'NoneType'>),
    'deactivated_reason': (   <class 'str'>,
                              <class 'NoneType'>),
    'email': <class 'str'>,
    'gitlab': (   <class 'str'>,
                  <class 'NoneType'>),
    'id': <class 'int'>,
    'last_seen': (   <class 'str'>,
                     <class 'NoneType'>),
    'name': <class 'str'>,
    'permissions': (   {   'add_user': ForwardRef('bool'),
                           'edit_plone': ForwardRef('Union[bool, List[int]]'),
                           'edit_server': ForwardRef('Union[bool, List[int]]'),
                           'remove_user': ForwardRef('bool'),
                           'update_user': ForwardRef('bool'),
                           'view_gitlab': ForwardRef('Union[bool, List[int]]'),
                           'view_gitlab_runner': ForwardRef('bool'),
                           'view_plone': ForwardRef('Union[bool, List[int]]'),
                           'view_server': ForwardRef('Union[bool, List[int]]'),
                           'view_user': ForwardRef('bool')},
                       <class 'NoneType'>),
    'redmine': (   <class 'str'>,
                   <class 'NoneType'>),
    'registered': (   <class 'str'>,
                      <class 'NoneType'>),
    'sentry': (   <class 'str'>,
                  <class 'NoneType'>),
    'slack': (   <class 'str'>,
                 <class 'NoneType'>)}

PUT /user/update_credentials

Updates the credentials for the signed-in User

Response

<class 'bool'>