Created
July 4, 2018 08:33
-
-
Save kinlane/be2fca862450760e9abf434ea6efb686 to your computer and use it in GitHub Desktop.
automox api
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "1.0.0", | |
| "title": "Automox API", | |
| "description": "The Automox API is a powerful interface that allows you to integrate Automox reporting data into you applications and control the various settings of your account.\n\nAll endpoints are only accessible via https and are located at\n`api.automox.com`. For instance: you can see events associated with your account by accessing the following URL with your ID:\n(replace API-KEY with your own):\n```\n https://console.automox.com/api/events?api_key=API-KEY\n```\n## Limits\nBe nice. If you're sending too many requests too quickly, we'll send back a\n`429` error code (Too Many Requests).\nYou are limited to 5000 requests per hour per `api_key` overall. Practically, this means you should (when possible) authenticate\nusers so that limits are well outside the reach of a given user.\n", | |
| "termsOfService": "https://www.automox.com/", | |
| "contact": { | |
| "name": "support@automox.com" | |
| } | |
| }, | |
| "host": "console.automox.com", | |
| "basePath": "/api", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "paths": { | |
| "/events": { | |
| "get": { | |
| "tags": [ | |
| "events" | |
| ], | |
| "description": "Gets all `Event` objects for the authenticated user.\n", | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Event" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/events/{id}": { | |
| "get": { | |
| "tags": [ | |
| "events" | |
| ], | |
| "description": "Gets a specific `Event` object for the authenticated user.\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "event ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Event" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/orgs": { | |
| "get": { | |
| "tags": [ | |
| "organizations" | |
| ], | |
| "description": "Gets all organizations for the api key\n", | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Organization" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/orgs/{id}/packages": { | |
| "get": { | |
| "tags": [ | |
| "organizations" | |
| ], | |
| "description": "Returns all software packages discovered on all servers (endpoints) of an organization\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Packages" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/policies": { | |
| "get": { | |
| "tags": [ | |
| "policies" | |
| ], | |
| "description": "Gets all `Policy` objects for authenticated user\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Policy" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/policies/{id}": { | |
| "get": { | |
| "tags": [ | |
| "policies" | |
| ], | |
| "description": "Gets a specific `Policy` object for the authenticated user.\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Policy ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Policy" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "policies" | |
| ], | |
| "description": "Updates a `Policy` object\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Policy ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "policy", | |
| "description": "Updated policy object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Policy" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/policies/{id}/action": { | |
| "post": { | |
| "tags": [ | |
| "policies" | |
| ], | |
| "description": "Schedule a policy for immediate remediation\n", | |
| "consumes": [ | |
| "multipart/form-data" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Policy ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "action", | |
| "description": "Remediation action type [remediateAll]", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/policysets": { | |
| "get": { | |
| "tags": [ | |
| "policysets" | |
| ], | |
| "description": "Gets all `Policy Set` objects for authenticated user\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PolicySets" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/policystats": { | |
| "get": { | |
| "tags": [ | |
| "policies", | |
| "stats" | |
| ], | |
| "description": "Gets all `Policy Stats` objects for authenticated user\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PolicyStats" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/servers": { | |
| "get": { | |
| "tags": [ | |
| "endpoints" | |
| ], | |
| "summary": "Get details for all servers", | |
| "description": "Gets all `Server` objects for authenticated user\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Server" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/servers/{id}": { | |
| "get": { | |
| "tags": [ | |
| "endpoints" | |
| ], | |
| "summary": "Get a detail for a specific server", | |
| "description": "Gets a specific `Server` object for the authenticated user.\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server (endpoint) ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Server" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "endpoints" | |
| ], | |
| "summary": "Update a server object", | |
| "description": "Updates a `Server` object\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server (endpoint) ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "server", | |
| "description": "Updated server object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Server" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "endpoints" | |
| ], | |
| "summary": "Deletes a server", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server (endpoint) ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/servers/{id}/packages": { | |
| "get": { | |
| "tags": [ | |
| "endpoints" | |
| ], | |
| "description": "Returns the command queue for the specified server (endpoint)\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server (endpoint) ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Packages" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/servers/{id}/queues": { | |
| "get": { | |
| "tags": [ | |
| "endpoints", | |
| "queues", | |
| "commands" | |
| ], | |
| "description": "Returns the command queue for the specified server (endpoint)\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server (endpoint) ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Command" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "endpoints", | |
| "queues", | |
| "commands" | |
| ], | |
| "description": "Issue a command to an endpoint. Can be used to install a specific set of patches or reboot an endpoint\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server (endpoint) ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "command", | |
| "description": "Command object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Command" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Command" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/servergroups": { | |
| "get": { | |
| "tags": [ | |
| "groups" | |
| ], | |
| "description": "Gets all `Server Group` objects for authenticated user\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ServerGroup" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "groups" | |
| ], | |
| "description": "Updates a `Server Group` object\n", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "servergroup", | |
| "description": "Updated server object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ServerGroupP" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/servergroups/{id}": { | |
| "get": { | |
| "tags": [ | |
| "groups" | |
| ], | |
| "description": "Gets a specific `Server Group` object for the authenticated user.\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server Group ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/ServerGroup" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "groups" | |
| ], | |
| "description": "Updates a `Server Group` object\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server Group ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "servergroup", | |
| "description": "Updated server object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ServerGroupP" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "groups" | |
| ], | |
| "summary": "Deletes a server group", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Server Group ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/software_version": { | |
| "get": { | |
| "tags": [ | |
| "software", | |
| "approvals" | |
| ], | |
| "description": "Retrieves software packages and patches for an organization, specific policy, or just those that need [approval | attention | exceptions | pending update].\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "policyId", | |
| "description": "Return results for a specific Policy ID", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "needsApproval", | |
| "description": "Retrieve software that needs approval", | |
| "required": false, | |
| "type": "integer", | |
| "enum": [ | |
| 0, | |
| 1 | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "needsAttention", | |
| "description": "Retrieve software that needs attention", | |
| "required": false, | |
| "type": "integer", | |
| "enum": [ | |
| 0, | |
| 1 | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "exceptions", | |
| "description": "Retrieve software that applies to exception endpoints", | |
| "required": false, | |
| "type": "integer", | |
| "enum": [ | |
| 0, | |
| 1 | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "pendingUpdate", | |
| "description": "Retrieve software that is pending update", | |
| "required": false, | |
| "type": "integer", | |
| "enum": [ | |
| 0, | |
| 1 | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "l", | |
| "description": "Result Limit", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "p", | |
| "description": "Page Number", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SoftwareVersion" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/software": { | |
| "get": { | |
| "tags": [ | |
| "software" | |
| ], | |
| "description": "Retrieves software packages and patches for an organization, allows filtering the list of software by name\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "name", | |
| "description": "Name of software package (wildcards ok) i.e. *KB12345*", | |
| "required": false, | |
| "type": "string", | |
| "format": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "limit", | |
| "description": "Limit number of results returned", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "groupID", | |
| "description": "Return software for a given group ID", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SoftwareSearch" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/approvals/{id}": { | |
| "put": { | |
| "tags": [ | |
| "software", | |
| "approvals" | |
| ], | |
| "description": "Update a manual approval record. Set `manual_approval` attribute of `approval` object to `true` to approve a patch; set it to `false` to reject a patch\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Approval ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "approval", | |
| "description": "Approval object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/SoftwareApprovals" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/users": { | |
| "get": { | |
| "tags": [ | |
| "users" | |
| ], | |
| "description": "Gets all `User` objects for the authenticated user.\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "o", | |
| "description": "Organization ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/User" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/users/{id}/queues": { | |
| "get": { | |
| "tags": [ | |
| "users", | |
| "queues", | |
| "commands" | |
| ], | |
| "description": "Gets all commands executed for specified user id\n", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "User ID or `self` for current user", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/Command" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/reports/prepatch": { | |
| "get": { | |
| "tags": [ | |
| "reports" | |
| ], | |
| "description": "Retrieve the prepatch report\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "startDate", | |
| "description": "Report Start Date - `YYYY-MM-DD`", | |
| "required": false, | |
| "type": "string", | |
| "format": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/PrePatch" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/reports/noncompliance": { | |
| "get": { | |
| "tags": [ | |
| "reports" | |
| ], | |
| "description": "Retrieve the non compliant devices report\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "startDate", | |
| "description": "Report Start Date - `YYYY-MM-DD`", | |
| "required": false, | |
| "type": "string", | |
| "format": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "schema": { | |
| "$ref": "#/definitions/NonCompliant" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "api_key": [] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "securityDefinitions": { | |
| "api_key": { | |
| "type": "apiKey", | |
| "name": "api_key", | |
| "in": "query" | |
| } | |
| }, | |
| "definitions": { | |
| "Event": { | |
| "type": "object", | |
| "properties": { | |
| "create_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "data": { | |
| "$ref": "#/definitions/EventData" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Event type", | |
| "example": "system.add" | |
| }, | |
| "policy_id": { | |
| "type": "integer" | |
| }, | |
| "policy_name": { | |
| "type": "string" | |
| }, | |
| "policy_type_name": { | |
| "type": "string" | |
| }, | |
| "server_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "server_name": { | |
| "type": "string" | |
| }, | |
| "user_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "EventData": { | |
| "type": "object", | |
| "properties": { | |
| "firstname": { | |
| "type": "string" | |
| }, | |
| "lastname": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "orgname": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "os": { | |
| "type": "string" | |
| }, | |
| "systemname": { | |
| "type": "string" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "patches": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Policy": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "organization_id", | |
| "policy_type_name", | |
| "schedule_days", | |
| "schedule_time", | |
| "configuration", | |
| "notes" | |
| ], | |
| "properties": { | |
| "configuration": { | |
| "$ref": "#/definitions/PolicyConfiguration" | |
| }, | |
| "create_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notes": { | |
| "type": "string" | |
| }, | |
| "organization_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "policy_type_name": { | |
| "type": "string" | |
| }, | |
| "schedule_days": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "schedule_time": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PolicyConfiguration": { | |
| "type": "object", | |
| "required": [ | |
| "auto_patch", | |
| "auto_reboot" | |
| ], | |
| "properties": { | |
| "auto_patch": { | |
| "type": "boolean" | |
| }, | |
| "auto_reboot": { | |
| "type": "boolean" | |
| }, | |
| "installation_code": { | |
| "type": "string" | |
| }, | |
| "os_family": { | |
| "type": "string" | |
| }, | |
| "package_name": { | |
| "type": "string" | |
| }, | |
| "evaluation_code": { | |
| "type": "string" | |
| }, | |
| "remediation_code": { | |
| "type": "string" | |
| }, | |
| "test_code": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PolicySets": { | |
| "type": "object", | |
| "properties": { | |
| "create_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notes": { | |
| "type": "string" | |
| }, | |
| "organization_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "policies": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| }, | |
| "PolicyStats": { | |
| "type": "object", | |
| "properties": { | |
| "compliant": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "noncompliant": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "organization_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "pending": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "policy_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "policy_name": { | |
| "type": "string" | |
| }, | |
| "policy_type_name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Server": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "create_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "deleted": { | |
| "type": "boolean" | |
| }, | |
| "detail": { | |
| "$ref": "#/definitions/ServerDetail" | |
| }, | |
| "instance_id": { | |
| "type": "string" | |
| }, | |
| "ip_addrs": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "last_checkin_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "last_refresh_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "last_update_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "needs_reboot": { | |
| "type": "boolean" | |
| }, | |
| "organization_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "os_family": { | |
| "type": "string" | |
| }, | |
| "os_name": { | |
| "type": "string" | |
| }, | |
| "os_version_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "patches": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "refresh_interval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "server_group_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "uptime": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "uuid": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ServerDetail": { | |
| "type": "object", | |
| "properties": { | |
| "CPU": { | |
| "type": "string" | |
| }, | |
| "DISKS": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Disks" | |
| } | |
| }, | |
| "MODEL": { | |
| "type": "string" | |
| }, | |
| "NICS": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Nics" | |
| } | |
| }, | |
| "RAM": { | |
| "type": "string" | |
| }, | |
| "SERIAL": { | |
| "type": "string" | |
| }, | |
| "SERVICETAG": { | |
| "type": "string" | |
| }, | |
| "VENDOR": { | |
| "type": "string" | |
| }, | |
| "VERSION": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Disks": { | |
| "type": "object", | |
| "properties": { | |
| "SIZE": { | |
| "type": "string" | |
| }, | |
| "TYPE": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Nics": { | |
| "type": "object", | |
| "properties": { | |
| "CONNECTED": { | |
| "type": "boolean" | |
| }, | |
| "DEVICE": { | |
| "type": "string" | |
| }, | |
| "IPS": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "MAC": { | |
| "type": "string" | |
| }, | |
| "TYPE": { | |
| "type": "string" | |
| }, | |
| "VENDOR": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Organization": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "access_key": { | |
| "type": "string" | |
| }, | |
| "addr1": { | |
| "type": "string" | |
| }, | |
| "addr2": { | |
| "type": "string" | |
| }, | |
| "billing_interval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "billing_interval_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "cc_brand": { | |
| "type": "string" | |
| }, | |
| "cc_exp": { | |
| "type": "string" | |
| }, | |
| "cc_last": { | |
| "type": "string" | |
| }, | |
| "cc_name": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "create_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "rate": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "server_limit": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "stripe_cust": { | |
| "type": "string" | |
| }, | |
| "subscription": { | |
| "type": "string" | |
| }, | |
| "trial_end_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "trial_expired": { | |
| "type": "boolean" | |
| }, | |
| "zipcode": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Command": { | |
| "type": "object", | |
| "required": [ | |
| "args", | |
| "command_type_name", | |
| "exec_time" | |
| ], | |
| "example": { | |
| "command_type_name": "InstallUpdate", | |
| "args": "KB12345 KB67890", | |
| "exec_time": "2017-06-29T16:39:50.951Z" | |
| }, | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "server_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "policy_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "command_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "command_type_name": { | |
| "type": "string", | |
| "enum": [ | |
| "InstallUpdate", | |
| "Reboot" | |
| ], | |
| "description": "Type of command being issued" | |
| }, | |
| "args": { | |
| "type": "string", | |
| "example": "\"KB12345 KB67890\"", | |
| "description": "List of patches to apply, or NULL if issuing a Reboot" | |
| }, | |
| "response": { | |
| "type": "string" | |
| }, | |
| "response_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "create_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "exec_time": { | |
| "type": "string", | |
| "format": "date-time", | |
| "example": "2017-06-29T16:39:50.951Z", | |
| "description": "Time to execute the command, or NULL if issuing a Reboot" | |
| } | |
| } | |
| }, | |
| "Packages": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "server_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "package_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "installed": { | |
| "type": "boolean" | |
| }, | |
| "ignored": { | |
| "type": "boolean" | |
| }, | |
| "deferred_until": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "display_name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "repo": { | |
| "type": "string" | |
| }, | |
| "package_type_name": { | |
| "type": "string" | |
| }, | |
| "group_ignored": { | |
| "type": "boolean" | |
| }, | |
| "group_deferred_until": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "cves": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "cve_score": { | |
| "type": "string" | |
| }, | |
| "package_version_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "os_name": { | |
| "type": "string" | |
| }, | |
| "os_version": { | |
| "type": "string" | |
| }, | |
| "os_version_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "create_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "User": { | |
| "type": "object", | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "features": { | |
| "type": "object", | |
| "items": { | |
| "$ref": "#/definitions/Features" | |
| } | |
| }, | |
| "firstname": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "lastname": { | |
| "type": "string" | |
| }, | |
| "orgs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UserOrgs" | |
| } | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "UserOrgs": { | |
| "type": "object", | |
| "properties": { | |
| "access_key": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "trial_end_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "trial_expired": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "Features": { | |
| "type": "object", | |
| "properties": { | |
| "mo": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "ServerGroup": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "override": { | |
| "type": "boolean" | |
| }, | |
| "parent_server_group_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "policy_set_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "refresh_interval": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "ServerGroupP": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "override": { | |
| "type": "boolean" | |
| }, | |
| "parent_server_group_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "refresh_interval": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "SoftwareVersion": { | |
| "type": "object", | |
| "properties": { | |
| "server_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "severity_low_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "severity_medium_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "severity_high_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "severity_other_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SoftwareResults" | |
| } | |
| } | |
| } | |
| }, | |
| "SoftwareSearch": { | |
| "type": "object", | |
| "properties": { | |
| "size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SoftwareSearchResults" | |
| } | |
| } | |
| } | |
| }, | |
| "SoftwareSearchResults": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "display_name": { | |
| "type": "string" | |
| }, | |
| "os_family_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "os_family": { | |
| "type": "string" | |
| }, | |
| "total_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "SoftwareResults": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "software_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "display_name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "os_family": { | |
| "type": "string" | |
| }, | |
| "severity": { | |
| "type": "string" | |
| }, | |
| "server_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "approvals": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SoftwareApprovals" | |
| } | |
| }, | |
| "pending_update": { | |
| "type": "object" | |
| }, | |
| "total_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "total_server_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "total_severity_low_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "total_severity_medium_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "total_severity_high_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "total_severity_other_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "SoftwareApprovals": { | |
| "type": "object", | |
| "required": [ | |
| "manual_approval" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "software_version_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "policy_id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "manual_approval": { | |
| "type": "boolean", | |
| "description": "true = Approved, false = Rejected" | |
| }, | |
| "manual_approval_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "auto_approval": { | |
| "type": "boolean" | |
| }, | |
| "server_count": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "PrePatch": { | |
| "type": "object", | |
| "properties": { | |
| "needsAttention": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "low": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "medium": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "high": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "other": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "devices": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Devices" | |
| } | |
| } | |
| } | |
| }, | |
| "Devices": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "createTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "group": { | |
| "type": "string" | |
| }, | |
| "lastCheckinTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "needsReboot": { | |
| "type": "boolean" | |
| }, | |
| "os_family": { | |
| "type": "string" | |
| }, | |
| "compliant": { | |
| "type": "boolean" | |
| }, | |
| "patches": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Patches" | |
| } | |
| } | |
| } | |
| }, | |
| "Patches": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "packageVersionId": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "severity": { | |
| "type": "string" | |
| }, | |
| "cve": { | |
| "type": "string" | |
| }, | |
| "createTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "patchTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "needsApproval": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "NonCompliant": { | |
| "type": "object", | |
| "properties": { | |
| "total": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "low": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "medium": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "high": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "other": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "devices": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/NCDevices" | |
| } | |
| } | |
| } | |
| }, | |
| "NCDevices": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "customName": { | |
| "type": "string" | |
| }, | |
| "serverCreateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lastCheckinTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lastRefreshTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "needsReboot": { | |
| "type": "boolean" | |
| }, | |
| "groupId": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "os_family": { | |
| "type": "string" | |
| }, | |
| "policies": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/NCPolicies" | |
| } | |
| } | |
| } | |
| }, | |
| "NCPolicies": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "reasonForFail": { | |
| "type": "string" | |
| }, | |
| "policyCreateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "severity": { | |
| "type": "string" | |
| }, | |
| "packages": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/NCPackages" | |
| } | |
| } | |
| } | |
| }, | |
| "NCPackages": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "severity": { | |
| "type": "string" | |
| }, | |
| "packageVersionId": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "createTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment