{
  "opencollection": "1.0.0",
  "info": {
    "name": "FOSSology Admin API",
    "version": "1.6.2"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Admin",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of obligations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/obligations/list"
          },
          "docs": "Get the list of obligations in the server.\n"
        },
        {
          "info": {
            "name": "Get details of a particular obligation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/obligations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the obligation"
              }
            ]
          },
          "docs": "Get the details of a particular obligation from the server.\n"
        },
        {
          "info": {
            "name": "Delete a particular obligation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost/repo/api/v1/obligations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the obligation"
              }
            ]
          },
          "docs": "Delete a particular obligation from the server.\n"
        },
        {
          "info": {
            "name": "Get details of a all obligations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/obligations"
          },
          "docs": "Get the details of all obligations from the server.\n"
        },
        {
          "info": {
            "name": "getUsers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/users"
          },
          "docs": "Get the registered users"
        },
        {
          "info": {
            "name": "Create a new user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost/repo/api/v1/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new user\n"
        },
        {
          "info": {
            "name": "Get user by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get one single user by id\n"
        },
        {
          "info": {
            "name": "Edit user details by id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost/repo/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Edit user details by id\n"
        },
        {
          "info": {
            "name": "Delete user by id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost/repo/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a single user by id\n"
        },
        {
          "info": {
            "name": "Create a new REST API Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost/repo/api/v1/users/tokens",
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "Create a new REST API Token\n"
        },
        {
          "info": {
            "name": "Get all the REST API tokens (active | expired)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/users/tokens/:type",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get all the REST API tokens (active | expired)\n"
        },
        {
          "info": {
            "name": "get scheduler options by operation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/jobs/scheduler/operation/:operationName",
            "params": [
              {
                "name": "operationName",
                "value": "",
                "type": "path",
                "description": "Name of the operation"
              }
            ]
          },
          "docs": "Returns the scheduler options for a specific operation"
        },
        {
          "info": {
            "name": "Run the scheduler",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost/repo/api/v1/jobs/scheduler/operation/run",
            "params": [
              {
                "name": "job",
                "value": "",
                "type": "query",
                "description": "Name of the selected job"
              },
              {
                "name": "level",
                "value": "",
                "type": "query",
                "description": "Level of the selected verbose"
              },
              {
                "name": "priority",
                "value": "",
                "type": "query",
                "description": "Priority option selected"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Run the scheduler with the selected options from a specific operation"
        },
        {
          "info": {
            "name": "Create a new folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost/repo/api/v1/folders",
            "headers": [
              {
                "name": "groupName",
                "value": ""
              },
              {
                "name": "parentFolder",
                "value": ""
              },
              {
                "name": "folderName",
                "value": ""
              },
              {
                "name": "folderDescription",
                "value": ""
              }
            ]
          },
          "docs": "Create a new child folder with optional description\n"
        },
        {
          "info": {
            "name": "Delete a folder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost/repo/api/v1/folders/:id",
            "headers": [
              {
                "name": "groupName",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the folder"
              }
            ]
          },
          "docs": "Schedule a folder deletion\n"
        },
        {
          "info": {
            "name": "Get the Admin configuration data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/customise"
          },
          "docs": "Returns the admin configuration data from the server\n"
        },
        {
          "info": {
            "name": "Update the Admin configuration data",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost/repo/api/v1/customise",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the admin configuration data.\n"
        },
        {
          "info": {
            "name": "Create a new group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost/repo/api/v1/groups",
            "headers": [
              {
                "name": "name",
                "value": ""
              }
            ]
          },
          "docs": "Create a new user group\n"
        },
        {
          "info": {
            "name": "Add user to a group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost/repo/api/v1/groups/:id/user/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the group"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "user id of the member"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "add a new user to group\n"
        },
        {
          "info": {
            "name": "Delete license candidate by id.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost/repo/api/v1/license/admincandidates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the license-candidate"
              }
            ]
          },
          "docs": "Delete a single admin-license-candidate by the given id.\n"
        },
        {
          "info": {
            "name": "Verify a license as new or variant",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost/repo/api/v1/license/verify/:shortname",
            "params": [
              {
                "name": "shortname",
                "value": "",
                "type": "path",
                "description": "Shortname of the license to be verified"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verify a license as new or variant of another license\n"
        },
        {
          "info": {
            "name": "Merge a license with another",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost/repo/api/v1/license/merge/:shortname",
            "params": [
              {
                "name": "shortname",
                "value": "",
                "type": "path",
                "description": "Shortname of the license to be merged"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Merge a license to another existing license\n"
        },
        {
          "info": {
            "name": "Get database contents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/overview/database/contents"
          },
          "docs": "Get database contents for the dashboard display.\n"
        },
        {
          "info": {
            "name": "Get PHP info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/overview/info/php"
          },
          "docs": "Get PHP info\n"
        },
        {
          "info": {
            "name": "Get disk usage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/overview/disk/usage"
          },
          "docs": "Get disk usage\n"
        },
        {
          "info": {
            "name": "Get suggested license by reference text.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost/repo/api/v1/license/suggest",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get a single suggested license by the given reference text.\n"
        },
        {
          "info": {
            "name": "Get database metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/overview/database/metrics"
          },
          "docs": "Get database metrics for the dashboard display.\n"
        },
        {
          "info": {
            "name": "Get active queries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost/repo/api/v1/overview/queries/active"
          },
          "docs": "Get a list of active queries from the database.\n"
        }
      ]
    }
  ],
  "bundled": true
}