{
  "opencollection": "1.0.0",
  "info": {
    "name": "external/applications/applications.proto ApplicationsService JobsService API",
    "version": "version not set"
  },
  "items": [
    {
      "info": {
        "name": "JobsService",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a scan job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v0/compliance/scanner/jobs"
          },
          "docs": "Creates a scan job. A scan job executes Chef InSpec against the specified nodes.\nRequires a user-specified name. Type should be `detect` (checks if the node is reachable and reports the\nplatform information for the nodes) or `exec` (executes a set of profiles against the nodes).\nNodes to scan may be specified by including an array of node IDs to scan or a node manager ID along with some optional\nfiltering information.\nExec jobs require at least one profile to be used as part of the Chef InSpec s"
        },
        {
          "info": {
            "name": "Read a scan job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v0/compliance/scanner/jobs/id/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique ID (UUID) assigned to object."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of object."
              }
            ]
          },
          "docs": "Read the details of a scan job given an ID.\n\nAuthorization Action:\n\n```\ncompliance:scannerJobs:get\n```"
        },
        {
          "info": {
            "name": "Update a job",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v0/compliance/scanner/jobs/id/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique ID (UUID) of the scan job."
              }
            ]
          },
          "docs": "PUT operation to update the details for a scan job, such as the name, profiles, node set, or recurrence schedule.\nPlease note that this is a PUT operation, so all scan job details included in the create function\nshould be included in the PUT message to update.\t\n\nAuthorization Action:\n\n```\ncompliance:scannerJobs:update\n```"
        },
        {
          "info": {
            "name": "Delete a scan job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v0/compliance/scanner/jobs/id/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique ID (UUID) assigned to object."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of object."
              }
            ]
          },
          "docs": "Delete a scan job given an ID. Note this does not delete the report(s) generated by the scan job.\n\nAuthorization Action:\n\n```\ncompliance:scannerJobs:delete\n```"
        },
        {
          "info": {
            "name": "Rerun a scan job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v0/compliance/scanner/jobs/rerun/id/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique ID (UUID) assigned to object."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of object."
              }
            ]
          },
          "docs": "Does not create a new job in the database. Reads the job info given the job ID\nand runs a scan. The latest job information is then updated to reflect this latest run.\t\n\nAuthorization Action:\n\n```\ncompliance:scannerJobs:rerun\n```"
        },
        {
          "info": {
            "name": "List of scan jobs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v0/compliance/scanner/jobs/search"
          },
          "docs": "Returns a list of scan jobs matching the query.\nSupports filtering, sorting, and pagination.\nValid filtering fields: job_type, parent_job, status\nValid sorting fields: name, type, status, start_time, end_time\n\nExample:\n```\n{\n\"filters\":[\n{\"key\":\"job_type\",\"values\":[\"exec\"]},\n{\"key\":\"parent_job\",\"values\":[\"\"]}\n],\n\"page\":1,\n\"per_page\":100,\n\"sort\":\"end_time\",\n\"order\":\"DESC\"\n} \n```\n\nAuthorization Action:\n\n```\ncompliance:scannerJobs:list\n```"
        }
      ]
    }
  ],
  "bundled": true
}