openapi: 3.0.3 info: title: OCS Inventory Backend API References version: 3.0.0 paths: /accountinfo/config/: get: operationId: accountinfo_config_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: datatarget schema: type: string enum: - ASSET - IPDISCOVER description: |- * `ASSET` - Assets * `IPDISCOVER` - IPDiscover - in: query name: datatype schema: type: string enum: - CHECKBOX - SELECT - TEXT - TEXTAREA description: |- * `TEXT` - Text * `TEXTAREA` - Textarea * `SELECT` - Select * `CHECKBOX` - Checkbox - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - accountinfo security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountinfoConfigList' application/xml: schema: $ref: '#/components/schemas/PaginatedAccountinfoConfigList' description: '' post: operationId: accountinfo_config_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountinfoConfig' multipart/form-data: schema: $ref: '#/components/schemas/AccountinfoConfig' application/json: schema: $ref: '#/components/schemas/AccountinfoConfig' application/xml: schema: $ref: '#/components/schemas/AccountinfoConfig' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccountinfoConfig' application/xml: schema: $ref: '#/components/schemas/AccountinfoConfig' description: '' /accountinfo/config/{id}/: get: operationId: accountinfo_config_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo config. required: true tags: - accountinfo security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoConfig' application/xml: schema: $ref: '#/components/schemas/AccountinfoConfig' description: '' put: operationId: accountinfo_config_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo config. required: true tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountinfoConfig' multipart/form-data: schema: $ref: '#/components/schemas/AccountinfoConfig' application/json: schema: $ref: '#/components/schemas/AccountinfoConfig' application/xml: schema: $ref: '#/components/schemas/AccountinfoConfig' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoConfig' application/xml: schema: $ref: '#/components/schemas/AccountinfoConfig' description: '' patch: operationId: accountinfo_config_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo config. required: true tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAccountinfoConfig' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAccountinfoConfig' application/json: schema: $ref: '#/components/schemas/PatchedAccountinfoConfig' application/xml: schema: $ref: '#/components/schemas/PatchedAccountinfoConfig' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoConfig' application/xml: schema: $ref: '#/components/schemas/AccountinfoConfig' description: '' delete: operationId: accountinfo_config_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo config. required: true tags: - accountinfo security: - knoxApiToken: [] responses: '204': description: No response body /accountinfo/data/: get: operationId: accountinfo_data_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: object_id schema: type: integer - in: query name: object_slug schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - accountinfo security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountinfoDataList' application/xml: schema: $ref: '#/components/schemas/PaginatedAccountinfoDataList' description: '' post: operationId: accountinfo_data_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountinfoData' multipart/form-data: schema: $ref: '#/components/schemas/AccountinfoData' application/json: schema: $ref: '#/components/schemas/AccountinfoData' application/xml: schema: $ref: '#/components/schemas/AccountinfoData' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccountinfoData' application/xml: schema: $ref: '#/components/schemas/AccountinfoData' description: '' /accountinfo/data/{id}/: get: operationId: accountinfo_data_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo data. required: true tags: - accountinfo security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoData' application/xml: schema: $ref: '#/components/schemas/AccountinfoData' description: '' put: operationId: accountinfo_data_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo data. required: true tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountinfoData' multipart/form-data: schema: $ref: '#/components/schemas/AccountinfoData' application/json: schema: $ref: '#/components/schemas/AccountinfoData' application/xml: schema: $ref: '#/components/schemas/AccountinfoData' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoData' application/xml: schema: $ref: '#/components/schemas/AccountinfoData' description: '' patch: operationId: accountinfo_data_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo data. required: true tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAccountinfoData' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAccountinfoData' application/json: schema: $ref: '#/components/schemas/PatchedAccountinfoData' application/xml: schema: $ref: '#/components/schemas/PatchedAccountinfoData' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoData' application/xml: schema: $ref: '#/components/schemas/AccountinfoData' description: '' delete: operationId: accountinfo_data_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo data. required: true tags: - accountinfo security: - knoxApiToken: [] responses: '204': description: No response body /accountinfo/value/: get: operationId: accountinfo_value_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: accountinfo_config schema: type: integer - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: value schema: type: string tags: - accountinfo security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountinfoValueList' application/xml: schema: $ref: '#/components/schemas/PaginatedAccountinfoValueList' description: '' post: operationId: accountinfo_value_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountinfoValue' multipart/form-data: schema: $ref: '#/components/schemas/AccountinfoValue' application/json: schema: $ref: '#/components/schemas/AccountinfoValue' application/xml: schema: $ref: '#/components/schemas/AccountinfoValue' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccountinfoValue' application/xml: schema: $ref: '#/components/schemas/AccountinfoValue' description: '' /accountinfo/value/{id}/: get: operationId: accountinfo_value_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo value. required: true tags: - accountinfo security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoValue' application/xml: schema: $ref: '#/components/schemas/AccountinfoValue' description: '' put: operationId: accountinfo_value_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo value. required: true tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountinfoValue' multipart/form-data: schema: $ref: '#/components/schemas/AccountinfoValue' application/json: schema: $ref: '#/components/schemas/AccountinfoValue' application/xml: schema: $ref: '#/components/schemas/AccountinfoValue' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoValue' application/xml: schema: $ref: '#/components/schemas/AccountinfoValue' description: '' patch: operationId: accountinfo_value_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo value. required: true tags: - accountinfo requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAccountinfoValue' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAccountinfoValue' application/json: schema: $ref: '#/components/schemas/PatchedAccountinfoValue' application/xml: schema: $ref: '#/components/schemas/PatchedAccountinfoValue' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountinfoValue' application/xml: schema: $ref: '#/components/schemas/AccountinfoValue' description: '' delete: operationId: accountinfo_value_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this accountinfo value. required: true tags: - accountinfo security: - knoxApiToken: [] responses: '204': description: No response body /api-auth/token: post: operationId: api_auth_token_create description: |- View to issue a token from username and password credentials. Subclasses ObtainAuthToken so the endpoint keeps accepting JSON credentials and returning a "token" key, as the frontend and the agents expect, while the issued token is a knox one. tags: - api-auth requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthToken' multipart/form-data: schema: $ref: '#/components/schemas/AuthToken' application/json: schema: $ref: '#/components/schemas/AuthToken' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthToken' description: '' /api-auth/token/logout: post: operationId: api_auth_token_logout_create parameters: - in: query name: format schema: type: string enum: - json - xml tags: - api-auth security: - knoxApiToken: [] responses: '200': description: No response body /api-check/: get: operationId: api_check_retrieve description: Health check endpoint, used to verify the API is reachable. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - api-check security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApiCheckResponse' application/xml: schema: $ref: '#/components/schemas/ApiCheckResponse' description: '' /asset/bases/: get: operationId: asset_bases_list description: |- The default listing, plus the virtual columns asked for in the URL Values are resolved once for the page and passed by serializer context, so a column costs one query and not one per asset. parameters: - in: query name: agent schema: type: string - in: query name: description schema: type: string - in: query name: domain schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: is_template_forced schema: type: boolean - in: query name: last_update schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: osname schema: type: string - in: query name: osversion schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: serial schema: type: string - in: query name: srcip schema: type: string - in: query name: srcmac schema: type: string - in: query name: template schema: type: integer - in: query name: uuid schema: type: string tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryBaseList' application/xml: schema: $ref: '#/components/schemas/PaginatedInventoryBaseList' description: '' post: operationId: asset_bases_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventoryBase' multipart/form-data: schema: $ref: '#/components/schemas/InventoryBase' application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' description: '' /asset/bases/{id}/: get: operationId: asset_bases_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' description: '' put: operationId: asset_bases_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventoryBase' multipart/form-data: schema: $ref: '#/components/schemas/InventoryBase' application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' description: '' patch: operationId: asset_bases_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedInventoryBase' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInventoryBase' application/json: schema: $ref: '#/components/schemas/PatchedInventoryBase' application/xml: schema: $ref: '#/components/schemas/PatchedInventoryBase' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' description: '' delete: operationId: asset_bases_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - asset security: - knoxApiToken: [] responses: '204': description: No response body /asset/collection/: post: operationId: asset_collection_create description: Create an asset and its inventory (if template_inventory is provided). parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventoryBase' multipart/form-data: schema: $ref: '#/components/schemas/InventoryBase' application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CollectionResponse' application/xml: schema: $ref: '#/components/schemas/CollectionResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' '500': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' put: operationId: asset_collection_update description: Update an asset and fully overwrite its inventory (missing sections/fields are deleted). parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventoryBase' multipart/form-data: schema: $ref: '#/components/schemas/InventoryBase' application/json: schema: $ref: '#/components/schemas/InventoryBase' application/xml: schema: $ref: '#/components/schemas/InventoryBase' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CollectionResponse' application/xml: schema: $ref: '#/components/schemas/CollectionResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' '500': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' patch: operationId: asset_collection_partial_update description: Partially update an asset and its inventory (only the provided sections/fields are affected). parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedInventoryBase' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInventoryBase' application/json: schema: $ref: '#/components/schemas/PatchedInventoryBase' application/xml: schema: $ref: '#/components/schemas/PatchedInventoryBase' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CollectionResponse' application/xml: schema: $ref: '#/components/schemas/CollectionResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' '500': content: application/json: schema: $ref: '#/components/schemas/CollectionError' application/xml: schema: $ref: '#/components/schemas/CollectionError' description: '' /asset/configs/: get: operationId: asset_configs_list description: |- Allow read of agent config This view is reachable at the /asset/configs/ endpoint. GET: List agent configuration parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedConfigList' application/xml: schema: $ref: '#/components/schemas/PaginatedConfigList' description: '' /asset/configs/{name}/: get: operationId: asset_configs_retrieve description: |- Allow read of agent config This view is reachable at the /asset/configs/ endpoint. GET: List agent configuration parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: name schema: type: string description: A unique value identifying this config. required: true tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Config' application/xml: schema: $ref: '#/components/schemas/Config' description: '' /asset/fields/: get: operationId: asset_fields_list description: |- Template Field ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - in: query name: inventory_section schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: template_field schema: type: integer - in: query name: value schema: type: string tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryFieldList' application/xml: schema: $ref: '#/components/schemas/PaginatedInventoryFieldList' description: '' post: operationId: asset_fields_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventoryField' multipart/form-data: schema: $ref: '#/components/schemas/InventoryField' application/json: schema: $ref: '#/components/schemas/InventoryField' application/xml: schema: $ref: '#/components/schemas/InventoryField' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InventoryField' application/xml: schema: $ref: '#/components/schemas/InventoryField' description: '' /asset/fields/{id}/: get: operationId: asset_fields_retrieve description: |- Template Field ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory field. required: true tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryField' application/xml: schema: $ref: '#/components/schemas/InventoryField' description: '' put: operationId: asset_fields_update description: |- Template Field ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory field. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventoryField' multipart/form-data: schema: $ref: '#/components/schemas/InventoryField' application/json: schema: $ref: '#/components/schemas/InventoryField' application/xml: schema: $ref: '#/components/schemas/InventoryField' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryField' application/xml: schema: $ref: '#/components/schemas/InventoryField' description: '' patch: operationId: asset_fields_partial_update description: |- Template Field ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory field. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedInventoryField' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInventoryField' application/json: schema: $ref: '#/components/schemas/PatchedInventoryField' application/xml: schema: $ref: '#/components/schemas/PatchedInventoryField' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryField' application/xml: schema: $ref: '#/components/schemas/InventoryField' description: '' delete: operationId: asset_fields_destroy description: |- Template Field ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory field. required: true tags: - asset security: - knoxApiToken: [] responses: '204': description: No response body /asset/groups/: get: operationId: asset_groups_list description: |- AssetGroup ViewSet Inherits from RestrictVisibilityViewSet to restrict the visibility of the Search objects based on user and group membership parameters: - in: query name: assets schema: type: array items: type: integer explode: true style: form - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: is_dynamic schema: type: boolean - in: query name: last_updated schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAssetGroupList' application/xml: schema: $ref: '#/components/schemas/PaginatedAssetGroupList' description: '' post: operationId: asset_groups_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssetGroup' multipart/form-data: schema: $ref: '#/components/schemas/AssetGroup' application/json: schema: $ref: '#/components/schemas/AssetGroup' application/xml: schema: $ref: '#/components/schemas/AssetGroup' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AssetGroup' application/xml: schema: $ref: '#/components/schemas/AssetGroup' description: '' /asset/groups/{id}/: get: operationId: asset_groups_retrieve description: |- AssetGroup ViewSet Inherits from RestrictVisibilityViewSet to restrict the visibility of the Search objects based on user and group membership parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this asset group. required: true tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetGroup' application/xml: schema: $ref: '#/components/schemas/AssetGroup' description: '' put: operationId: asset_groups_update description: |- User needs to either be the creator or part of the group (if allow_group_modification is enabled) to modify a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this asset group. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AssetGroup' multipart/form-data: schema: $ref: '#/components/schemas/AssetGroup' application/json: schema: $ref: '#/components/schemas/AssetGroup' application/xml: schema: $ref: '#/components/schemas/AssetGroup' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetGroup' application/xml: schema: $ref: '#/components/schemas/AssetGroup' description: '' patch: operationId: asset_groups_partial_update description: |- AssetGroup ViewSet Inherits from RestrictVisibilityViewSet to restrict the visibility of the Search objects based on user and group membership parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this asset group. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAssetGroup' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAssetGroup' application/json: schema: $ref: '#/components/schemas/PatchedAssetGroup' application/xml: schema: $ref: '#/components/schemas/PatchedAssetGroup' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetGroup' application/xml: schema: $ref: '#/components/schemas/AssetGroup' description: '' delete: operationId: asset_groups_destroy description: User needs to be the creator to delete a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this asset group. required: true tags: - asset security: - knoxApiToken: [] responses: '204': description: No response body /asset/legacy/: post: operationId: asset_legacy_create description: Create or partially update an asset and its inventory from the legacy XML agent payload (OCS legacy protocol). tags: - asset requestBody: content: application/*: schema: $ref: '#/components/schemas/InventoryBase' required: true security: - knoxApiToken: [] responses: '200': content: application/xml: schema: $ref: '#/components/schemas/LegacyResponse' description: '' '201': content: application/xml: schema: $ref: '#/components/schemas/LegacyResponse' description: '' '400': content: application/xml: schema: $ref: '#/components/schemas/LegacyError' description: '' '500': content: application/xml: schema: $ref: '#/components/schemas/LegacyError' description: '' /asset/logs/: get: operationId: asset_logs_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: asset schema: type: integer - in: query name: comment schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: scope schema: type: string enum: - CONFIG_ERR - CONFIG_UPDATE - DEPLOYMENT_ACK - DEPLOYMENT_ERR - INVENTORY_BASE_ERR - INVENTORY_BASE_INSERT - INVENTORY_BASE_UPDATE - INVENTORY_EXT_ERR - INVENTORY_EXT_INSERT - INVENTORY_EXT_UPDATE - TEMPLATE_ERR - TEMPLATE_UPDATE - UNKNOWN description: |- * `INVENTORY_BASE_INSERT` - Inserting new items into the base inventory * `INVENTORY_BASE_UPDATE` - Updating existing items in the base inventory * `INVENTORY_EXT_INSERT` - Inserting new items into the extended inventory * `INVENTORY_EXT_UPDATE` - Updating existing items in the extended inventory * `INVENTORY_BASE_ERR` - Error related to the base inventory operations * `INVENTORY_EXT_ERR` - Error related to the extended inventory operations * `DEPLOYMENT_ACK` - Acknowledgment of a successful deployment * `DEPLOYMENT_ERR` - Error during the deployment process * `CONFIG_UPDATE` - Updating configuration settings * `CONFIG_ERR` - Error related to configuration operations * `TEMPLATE_UPDATE` - Updating templates for a process * `TEMPLATE_ERR` - Error related to template operations * `UNKNOWN` - Unknown error happend (default) - name: search required: false in: query description: A search term. schema: type: string - in: query name: timestamp schema: type: string format: date-time tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedLogList' application/xml: schema: $ref: '#/components/schemas/PaginatedLogList' description: '' post: operationId: asset_logs_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Log' multipart/form-data: schema: $ref: '#/components/schemas/Log' application/json: schema: $ref: '#/components/schemas/Log' application/xml: schema: $ref: '#/components/schemas/Log' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Log' application/xml: schema: $ref: '#/components/schemas/Log' description: '' /asset/logs/{id}/: get: operationId: asset_logs_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this log. required: true tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Log' application/xml: schema: $ref: '#/components/schemas/Log' description: '' put: operationId: asset_logs_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this log. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Log' multipart/form-data: schema: $ref: '#/components/schemas/Log' application/json: schema: $ref: '#/components/schemas/Log' application/xml: schema: $ref: '#/components/schemas/Log' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Log' application/xml: schema: $ref: '#/components/schemas/Log' description: '' patch: operationId: asset_logs_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this log. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedLog' multipart/form-data: schema: $ref: '#/components/schemas/PatchedLog' application/json: schema: $ref: '#/components/schemas/PatchedLog' application/xml: schema: $ref: '#/components/schemas/PatchedLog' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Log' application/xml: schema: $ref: '#/components/schemas/Log' description: '' delete: operationId: asset_logs_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this log. required: true tags: - asset security: - knoxApiToken: [] responses: '204': description: No response body /asset/reconciliation/: post: operationId: asset_reconciliation_create description: 'Check whether an asset exists based on reconciliation criteria. Returns {''id'': asset_id} if found, else {''id'': False}.' parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReconciliationResponse' application/xml: schema: $ref: '#/components/schemas/ReconciliationResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ReconciliationError' application/xml: schema: $ref: '#/components/schemas/ReconciliationError' description: '' /asset/sections/: get: operationId: asset_sections_list description: |- Inventory Section ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: base schema: type: integer - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: template_section schema: type: integer tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventorySectionList' application/xml: schema: $ref: '#/components/schemas/PaginatedInventorySectionList' description: '' post: operationId: asset_sections_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventorySection' multipart/form-data: schema: $ref: '#/components/schemas/InventorySection' application/json: schema: $ref: '#/components/schemas/InventorySection' application/xml: schema: $ref: '#/components/schemas/InventorySection' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InventorySection' application/xml: schema: $ref: '#/components/schemas/InventorySection' description: '' /asset/sections/{id}/: get: operationId: asset_sections_retrieve description: |- Inventory Section ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory section. required: true tags: - asset security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySection' application/xml: schema: $ref: '#/components/schemas/InventorySection' description: '' put: operationId: asset_sections_update description: |- Inventory Section ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory section. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/InventorySection' multipart/form-data: schema: $ref: '#/components/schemas/InventorySection' application/json: schema: $ref: '#/components/schemas/InventorySection' application/xml: schema: $ref: '#/components/schemas/InventorySection' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySection' application/xml: schema: $ref: '#/components/schemas/InventorySection' description: '' patch: operationId: asset_sections_partial_update description: |- Inventory Section ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory section. required: true tags: - asset requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedInventorySection' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInventorySection' application/json: schema: $ref: '#/components/schemas/PatchedInventorySection' application/xml: schema: $ref: '#/components/schemas/PatchedInventorySection' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySection' application/xml: schema: $ref: '#/components/schemas/InventorySection' description: '' delete: operationId: asset_sections_destroy description: |- Inventory Section ViewSet Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory section. required: true tags: - asset security: - knoxApiToken: [] responses: '204': description: No response body /auth_config/: get: operationId: auth_config_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: auth_method schema: type: integer - in: query name: description schema: type: string - in: query name: enabled schema: type: boolean - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: priority schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - auth_config security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAuthConfigList' application/xml: schema: $ref: '#/components/schemas/PaginatedAuthConfigList' description: '' post: operationId: auth_config_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - auth_config requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthConfig' multipart/form-data: schema: $ref: '#/components/schemas/AuthConfig' application/json: schema: $ref: '#/components/schemas/AuthConfig' application/xml: schema: $ref: '#/components/schemas/AuthConfig' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AuthConfig' application/xml: schema: $ref: '#/components/schemas/AuthConfig' description: '' /auth_config/{id}/: get: operationId: auth_config_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth config. required: true tags: - auth_config security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthConfig' application/xml: schema: $ref: '#/components/schemas/AuthConfig' description: '' put: operationId: auth_config_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth config. required: true tags: - auth_config requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthConfig' multipart/form-data: schema: $ref: '#/components/schemas/AuthConfig' application/json: schema: $ref: '#/components/schemas/AuthConfig' application/xml: schema: $ref: '#/components/schemas/AuthConfig' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthConfig' application/xml: schema: $ref: '#/components/schemas/AuthConfig' description: '' patch: operationId: auth_config_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth config. required: true tags: - auth_config requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAuthConfig' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAuthConfig' application/json: schema: $ref: '#/components/schemas/PatchedAuthConfig' application/xml: schema: $ref: '#/components/schemas/PatchedAuthConfig' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthConfig' application/xml: schema: $ref: '#/components/schemas/AuthConfig' description: '' delete: operationId: auth_config_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth config. required: true tags: - auth_config security: - knoxApiToken: [] responses: '204': description: No response body /auth_mapping/: get: operationId: auth_mapping_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: auth_config schema: type: integer - in: query name: external_field schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: internal_field schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - auth_mapping security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAuthMappingList' application/xml: schema: $ref: '#/components/schemas/PaginatedAuthMappingList' description: '' post: operationId: auth_mapping_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - auth_mapping requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthMapping' multipart/form-data: schema: $ref: '#/components/schemas/AuthMapping' application/json: schema: $ref: '#/components/schemas/AuthMapping' application/xml: schema: $ref: '#/components/schemas/AuthMapping' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AuthMapping' application/xml: schema: $ref: '#/components/schemas/AuthMapping' description: '' /auth_mapping/{id}/: get: operationId: auth_mapping_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth mapping. required: true tags: - auth_mapping security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthMapping' application/xml: schema: $ref: '#/components/schemas/AuthMapping' description: '' put: operationId: auth_mapping_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth mapping. required: true tags: - auth_mapping requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthMapping' multipart/form-data: schema: $ref: '#/components/schemas/AuthMapping' application/json: schema: $ref: '#/components/schemas/AuthMapping' application/xml: schema: $ref: '#/components/schemas/AuthMapping' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthMapping' application/xml: schema: $ref: '#/components/schemas/AuthMapping' description: '' patch: operationId: auth_mapping_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth mapping. required: true tags: - auth_mapping requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAuthMapping' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAuthMapping' application/json: schema: $ref: '#/components/schemas/PatchedAuthMapping' application/xml: schema: $ref: '#/components/schemas/PatchedAuthMapping' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthMapping' application/xml: schema: $ref: '#/components/schemas/AuthMapping' description: '' delete: operationId: auth_mapping_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth mapping. required: true tags: - auth_mapping security: - knoxApiToken: [] responses: '204': description: No response body /auth_method/: get: operationId: auth_method_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: auth_type schema: type: string enum: - OTHER - SSO description: |- * `SSO` - SSO * `OTHER` - OTHER - in: query name: enabled schema: type: boolean - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: priority schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - auth_method security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAuthMethodList' application/xml: schema: $ref: '#/components/schemas/PaginatedAuthMethodList' description: '' post: operationId: auth_method_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - auth_method requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthMethod' multipart/form-data: schema: $ref: '#/components/schemas/AuthMethod' application/json: schema: $ref: '#/components/schemas/AuthMethod' application/xml: schema: $ref: '#/components/schemas/AuthMethod' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AuthMethod' application/xml: schema: $ref: '#/components/schemas/AuthMethod' description: '' /auth_method/{id}/: get: operationId: auth_method_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth method. required: true tags: - auth_method security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthMethod' application/xml: schema: $ref: '#/components/schemas/AuthMethod' description: '' put: operationId: auth_method_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth method. required: true tags: - auth_method requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthMethod' multipart/form-data: schema: $ref: '#/components/schemas/AuthMethod' application/json: schema: $ref: '#/components/schemas/AuthMethod' application/xml: schema: $ref: '#/components/schemas/AuthMethod' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthMethod' application/xml: schema: $ref: '#/components/schemas/AuthMethod' description: '' patch: operationId: auth_method_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth method. required: true tags: - auth_method requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAuthMethod' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAuthMethod' application/json: schema: $ref: '#/components/schemas/PatchedAuthMethod' application/xml: schema: $ref: '#/components/schemas/PatchedAuthMethod' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthMethod' application/xml: schema: $ref: '#/components/schemas/AuthMethod' description: '' delete: operationId: auth_method_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this auth method. required: true tags: - auth_method security: - knoxApiToken: [] responses: '204': description: No response body /automation/action/: get: operationId: automation_action_list description: Action viewset parameters: - in: query name: action schema: type: string enum: - set description: '* `set` - Set' - in: query name: content_type schema: type: integer - in: query name: field schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: object_id schema: type: integer - in: query name: object_slug schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: priority schema: type: integer - in: query name: rule schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedActionList' application/xml: schema: $ref: '#/components/schemas/PaginatedActionList' description: '' post: operationId: automation_action_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Action' multipart/form-data: schema: $ref: '#/components/schemas/Action' application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' /automation/action/{id}/: get: operationId: automation_action_retrieve description: Action viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this action. required: true tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' put: operationId: automation_action_update description: Action viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this action. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Action' multipart/form-data: schema: $ref: '#/components/schemas/Action' application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' patch: operationId: automation_action_partial_update description: Action viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this action. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAction' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAction' application/json: schema: $ref: '#/components/schemas/PatchedAction' application/xml: schema: $ref: '#/components/schemas/PatchedAction' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' delete: operationId: automation_action_destroy description: Action viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this action. required: true tags: - automation security: - knoxApiToken: [] responses: '204': description: No response body /automation/history/: get: operationId: automation_history_list description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: comment schema: type: string - in: query name: date schema: type: string format: date-time - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: scheduler schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: status schema: type: integer tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHistoryList' application/xml: schema: $ref: '#/components/schemas/PaginatedHistoryList' description: '' post: operationId: automation_history_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/History' multipart/form-data: schema: $ref: '#/components/schemas/History' application/json: schema: $ref: '#/components/schemas/History' application/xml: schema: $ref: '#/components/schemas/History' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/History' application/xml: schema: $ref: '#/components/schemas/History' description: '' /automation/history/{id}/: get: operationId: automation_history_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this history. required: true tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/History' application/xml: schema: $ref: '#/components/schemas/History' description: '' put: operationId: automation_history_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this history. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/History' multipart/form-data: schema: $ref: '#/components/schemas/History' application/json: schema: $ref: '#/components/schemas/History' application/xml: schema: $ref: '#/components/schemas/History' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/History' application/xml: schema: $ref: '#/components/schemas/History' description: '' patch: operationId: automation_history_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this history. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedHistory' multipart/form-data: schema: $ref: '#/components/schemas/PatchedHistory' application/json: schema: $ref: '#/components/schemas/PatchedHistory' application/xml: schema: $ref: '#/components/schemas/PatchedHistory' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/History' application/xml: schema: $ref: '#/components/schemas/History' description: '' delete: operationId: automation_history_destroy description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this history. required: true tags: - automation security: - knoxApiToken: [] responses: '204': description: No response body /automation/rule/: get: operationId: automation_rule_list description: Rule viewset parameters: - in: query name: actions schema: type: array items: type: integer explode: true style: form - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: priority schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: trigger schema: type: string enum: - inventory_received - netdevice_received - user_login description: |- * `inventory_received` - Inventory Received * `user_login` - User Login * `netdevice_received` - Netdevice Received tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRuleList' application/xml: schema: $ref: '#/components/schemas/PaginatedRuleList' description: '' post: operationId: automation_rule_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Rule' multipart/form-data: schema: $ref: '#/components/schemas/Rule' application/json: schema: $ref: '#/components/schemas/Rule' application/xml: schema: $ref: '#/components/schemas/Rule' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Rule' application/xml: schema: $ref: '#/components/schemas/Rule' description: '' /automation/rule/{id}/: get: operationId: automation_rule_retrieve description: Rule viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rule' application/xml: schema: $ref: '#/components/schemas/Rule' description: '' put: operationId: automation_rule_update description: Rule viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Rule' multipart/form-data: schema: $ref: '#/components/schemas/Rule' application/json: schema: $ref: '#/components/schemas/Rule' application/xml: schema: $ref: '#/components/schemas/Rule' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rule' application/xml: schema: $ref: '#/components/schemas/Rule' description: '' patch: operationId: automation_rule_partial_update description: Rule viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedRule' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRule' application/json: schema: $ref: '#/components/schemas/PatchedRule' application/xml: schema: $ref: '#/components/schemas/PatchedRule' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rule' application/xml: schema: $ref: '#/components/schemas/Rule' description: '' delete: operationId: automation_rule_destroy description: Rule viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation security: - knoxApiToken: [] responses: '204': description: No response body /automation/scheduler/: get: operationId: automation_scheduler_list description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: active schema: type: boolean - in: query name: day_of_month schema: type: integer - in: query name: day_of_week schema: type: integer - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: hour schema: type: string format: time - in: query name: is_protected schema: type: boolean - in: query name: last_execution schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: recurrence schema: type: string enum: - daily - hourly - monthly - weekly description: |- * `hourly` - hourly * `daily` - daily * `weekly` - weekly * `monthly` - monthly - name: search required: false in: query description: A search term. schema: type: string tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSchedulerList' application/xml: schema: $ref: '#/components/schemas/PaginatedSchedulerList' description: '' post: operationId: automation_scheduler_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Scheduler' multipart/form-data: schema: $ref: '#/components/schemas/Scheduler' application/json: schema: $ref: '#/components/schemas/Scheduler' application/xml: schema: $ref: '#/components/schemas/Scheduler' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Scheduler' application/xml: schema: $ref: '#/components/schemas/Scheduler' description: '' /automation/scheduler/{id}/: get: operationId: automation_scheduler_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this scheduler. required: true tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Scheduler' application/xml: schema: $ref: '#/components/schemas/Scheduler' description: '' put: operationId: automation_scheduler_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this scheduler. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Scheduler' multipart/form-data: schema: $ref: '#/components/schemas/Scheduler' application/json: schema: $ref: '#/components/schemas/Scheduler' application/xml: schema: $ref: '#/components/schemas/Scheduler' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Scheduler' application/xml: schema: $ref: '#/components/schemas/Scheduler' description: '' patch: operationId: automation_scheduler_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this scheduler. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedScheduler' multipart/form-data: schema: $ref: '#/components/schemas/PatchedScheduler' application/json: schema: $ref: '#/components/schemas/PatchedScheduler' application/xml: schema: $ref: '#/components/schemas/PatchedScheduler' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Scheduler' application/xml: schema: $ref: '#/components/schemas/Scheduler' description: '' delete: operationId: automation_scheduler_destroy description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this scheduler. required: true tags: - automation security: - knoxApiToken: [] responses: '204': description: No response body /automation/triggers/: get: operationId: automation_triggers_list description: List all the triggers and the related models parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTriggerList' application/xml: schema: $ref: '#/components/schemas/PaginatedTriggerList' description: '' post: operationId: automation_triggers_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Trigger' multipart/form-data: schema: $ref: '#/components/schemas/Trigger' application/json: schema: $ref: '#/components/schemas/Trigger' application/xml: schema: $ref: '#/components/schemas/Trigger' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Trigger' application/xml: schema: $ref: '#/components/schemas/Trigger' description: '' /automation/triggers/{id}/: get: operationId: automation_triggers_retrieve description: Trigger viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Trigger' application/xml: schema: $ref: '#/components/schemas/Trigger' description: '' put: operationId: automation_triggers_update description: Trigger viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Trigger' multipart/form-data: schema: $ref: '#/components/schemas/Trigger' application/json: schema: $ref: '#/components/schemas/Trigger' application/xml: schema: $ref: '#/components/schemas/Trigger' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Trigger' application/xml: schema: $ref: '#/components/schemas/Trigger' description: '' patch: operationId: automation_triggers_partial_update description: Trigger viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTrigger' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTrigger' application/json: schema: $ref: '#/components/schemas/PatchedTrigger' application/xml: schema: $ref: '#/components/schemas/PatchedTrigger' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Trigger' application/xml: schema: $ref: '#/components/schemas/Trigger' description: '' delete: operationId: automation_triggers_destroy description: Trigger viewset parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this rule. required: true tags: - automation security: - knoxApiToken: [] responses: '204': description: No response body /categories/: get: operationId: categories_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - in: query name: inventory_sections schema: type: array items: type: integer explode: true style: form - in: query name: is_protected schema: type: boolean - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - categories security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCategoryList' application/xml: schema: $ref: '#/components/schemas/PaginatedCategoryList' description: '' post: operationId: categories_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - categories requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Category' multipart/form-data: schema: $ref: '#/components/schemas/Category' application/json: schema: $ref: '#/components/schemas/Category' application/xml: schema: $ref: '#/components/schemas/Category' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Category' application/xml: schema: $ref: '#/components/schemas/Category' description: '' /categories/{id}/: get: operationId: categories_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this category. required: true tags: - categories security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Category' application/xml: schema: $ref: '#/components/schemas/Category' description: '' put: operationId: categories_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this category. required: true tags: - categories requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Category' multipart/form-data: schema: $ref: '#/components/schemas/Category' application/json: schema: $ref: '#/components/schemas/Category' application/xml: schema: $ref: '#/components/schemas/Category' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Category' application/xml: schema: $ref: '#/components/schemas/Category' description: '' patch: operationId: categories_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this category. required: true tags: - categories requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedCategory' multipart/form-data: schema: $ref: '#/components/schemas/PatchedCategory' application/json: schema: $ref: '#/components/schemas/PatchedCategory' application/xml: schema: $ref: '#/components/schemas/PatchedCategory' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Category' application/xml: schema: $ref: '#/components/schemas/Category' description: '' delete: operationId: categories_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this category. required: true tags: - categories security: - knoxApiToken: [] responses: '204': description: No response body /column_layouts/: get: operationId: column_layouts_list description: |- This class will define the view behavior Args: viewsets ([RestrictVisibilityViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: target schema: type: string enum: - asset description: '* `asset` - Assets' tags: - column_layouts security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedColumnLayoutList' application/xml: schema: $ref: '#/components/schemas/PaginatedColumnLayoutList' description: '' post: operationId: column_layouts_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - column_layouts requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ColumnLayout' multipart/form-data: schema: $ref: '#/components/schemas/ColumnLayout' application/json: schema: $ref: '#/components/schemas/ColumnLayout' application/xml: schema: $ref: '#/components/schemas/ColumnLayout' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ColumnLayout' application/xml: schema: $ref: '#/components/schemas/ColumnLayout' description: '' /column_layouts/{id}/: get: operationId: column_layouts_retrieve description: |- This class will define the view behavior Args: viewsets ([RestrictVisibilityViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this column layout. required: true tags: - column_layouts security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ColumnLayout' application/xml: schema: $ref: '#/components/schemas/ColumnLayout' description: '' put: operationId: column_layouts_update description: |- User needs to either be the creator or part of the group (if allow_group_modification is enabled) to modify a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this column layout. required: true tags: - column_layouts requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ColumnLayout' multipart/form-data: schema: $ref: '#/components/schemas/ColumnLayout' application/json: schema: $ref: '#/components/schemas/ColumnLayout' application/xml: schema: $ref: '#/components/schemas/ColumnLayout' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ColumnLayout' application/xml: schema: $ref: '#/components/schemas/ColumnLayout' description: '' patch: operationId: column_layouts_partial_update description: |- This class will define the view behavior Args: viewsets ([RestrictVisibilityViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this column layout. required: true tags: - column_layouts requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedColumnLayout' multipart/form-data: schema: $ref: '#/components/schemas/PatchedColumnLayout' application/json: schema: $ref: '#/components/schemas/PatchedColumnLayout' application/xml: schema: $ref: '#/components/schemas/PatchedColumnLayout' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ColumnLayout' application/xml: schema: $ref: '#/components/schemas/ColumnLayout' description: '' delete: operationId: column_layouts_destroy description: User needs to be the creator to delete a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this column layout. required: true tags: - column_layouts security: - knoxApiToken: [] responses: '204': description: No response body /compliance/eol-extended-support/: get: operationId: compliance_eol_extended_support_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: cycle schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: product schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCustomEOLExtendedSupportList' application/xml: schema: $ref: '#/components/schemas/PaginatedCustomEOLExtendedSupportList' description: '' post: operationId: compliance_eol_extended_support_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' multipart/form-data: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/json: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/xml: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/xml: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' description: '' /compliance/eol-extended-support/{id}/: get: operationId: compliance_eol_extended_support_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this custom eol extended support. required: true tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/xml: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' description: '' put: operationId: compliance_eol_extended_support_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this custom eol extended support. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' multipart/form-data: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/json: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/xml: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/xml: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' description: '' patch: operationId: compliance_eol_extended_support_partial_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this custom eol extended support. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedCustomEOLExtendedSupport' multipart/form-data: schema: $ref: '#/components/schemas/PatchedCustomEOLExtendedSupport' application/json: schema: $ref: '#/components/schemas/PatchedCustomEOLExtendedSupport' application/xml: schema: $ref: '#/components/schemas/PatchedCustomEOLExtendedSupport' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' application/xml: schema: $ref: '#/components/schemas/CustomEOLExtendedSupport' description: '' delete: operationId: compliance_eol_extended_support_destroy description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this custom eol extended support. required: true tags: - compliance security: - knoxApiToken: [] responses: '204': description: No response body /compliance/eol-status/: get: operationId: compliance_eol_status_list description: |- Read-only viewset exposing per-asset EOL status. GET /compliance/eol-status/ parameters: - in: query name: asset schema: type: integer - in: query name: format schema: type: string enum: - json - xml - in: query name: is_eol schema: type: boolean - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: product schema: type: string - in: query name: product__isnull schema: type: boolean - name: search required: false in: query description: A search term. schema: type: string - in: query name: support schema: type: boolean tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAssetEOLStatusList' application/xml: schema: $ref: '#/components/schemas/PaginatedAssetEOLStatusList' description: '' /compliance/eol-status/{id}/: get: operationId: compliance_eol_status_retrieve description: |- Read-only viewset exposing per-asset EOL status. GET /compliance/eol-status/ parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this asset eol status. required: true tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetEOLStatus' application/xml: schema: $ref: '#/components/schemas/AssetEOLStatus' description: '' /compliance/eol-status/eol-summary/: get: operationId: compliance_eol_status_eol_summary_retrieve description: |- Return EOL status for a set of assets. GET /compliance/eol-status/eol-summary/?asset__in=1,2,3 parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssetEOLStatus' application/xml: schema: $ref: '#/components/schemas/AssetEOLStatus' description: '' /compliance/results/: get: operationId: compliance_results_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: asset schema: type: integer - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: rule schema: type: integer - in: query name: rule__severity schema: type: string enum: - critical - high - low - medium description: |- * `critical` - Critical * `high` - High * `medium` - Medium * `low` - Low - name: search required: false in: query description: A search term. schema: type: string - in: query name: status schema: type: string enum: - compliant - non_compliant - unknown description: |- * `compliant` - Compliant * `non_compliant` - Non-compliant * `unknown` - Unknown tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedComplianceResultList' application/xml: schema: $ref: '#/components/schemas/PaginatedComplianceResultList' description: '' post: operationId: compliance_results_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComplianceResult' multipart/form-data: schema: $ref: '#/components/schemas/ComplianceResult' application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' description: '' /compliance/results/{id}/: get: operationId: compliance_results_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance result. required: true tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' description: '' put: operationId: compliance_results_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance result. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComplianceResult' multipart/form-data: schema: $ref: '#/components/schemas/ComplianceResult' application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' description: '' patch: operationId: compliance_results_partial_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance result. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedComplianceResult' multipart/form-data: schema: $ref: '#/components/schemas/PatchedComplianceResult' application/json: schema: $ref: '#/components/schemas/PatchedComplianceResult' application/xml: schema: $ref: '#/components/schemas/PatchedComplianceResult' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' description: '' delete: operationId: compliance_results_destroy description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance result. required: true tags: - compliance security: - knoxApiToken: [] responses: '204': description: No response body /compliance/results/asset-summary/: get: operationId: compliance_results_asset_summary_retrieve description: |- Return aggregated compliance status per asset. GET /compliance/results/asset-summary/?asset__in=1,2,3 Returns a list of {asset, global_status, counts} for each asset that has at least one compliance result. Assets with no results are not included (the frontend treats them as not_applicable). parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' description: '' /compliance/results/rule-summary/: get: operationId: compliance_results_rule_summary_retrieve description: |- Return, for each compliance rule, the number of distinct assets that are non compliant with it. Rules with no impacted asset are included (impacted = 0). Mirrors asset-summary but aggregated per rule. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceResult' application/xml: schema: $ref: '#/components/schemas/ComplianceResult' description: '' /compliance/rules/: get: operationId: compliance_rules_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: enabled schema: type: boolean - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: severity schema: type: string enum: - critical - high - low - medium description: |- * `critical` - Critical * `high` - High * `medium` - Medium * `low` - Low - in: query name: type schema: type: string tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedComplianceRuleList' application/xml: schema: $ref: '#/components/schemas/PaginatedComplianceRuleList' description: '' post: operationId: compliance_rules_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComplianceRule' multipart/form-data: schema: $ref: '#/components/schemas/ComplianceRule' application/json: schema: $ref: '#/components/schemas/ComplianceRule' application/xml: schema: $ref: '#/components/schemas/ComplianceRule' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ComplianceRule' application/xml: schema: $ref: '#/components/schemas/ComplianceRule' description: '' /compliance/rules/{id}/: get: operationId: compliance_rules_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance rule. required: true tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceRule' application/xml: schema: $ref: '#/components/schemas/ComplianceRule' description: '' put: operationId: compliance_rules_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance rule. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComplianceRule' multipart/form-data: schema: $ref: '#/components/schemas/ComplianceRule' application/json: schema: $ref: '#/components/schemas/ComplianceRule' application/xml: schema: $ref: '#/components/schemas/ComplianceRule' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceRule' application/xml: schema: $ref: '#/components/schemas/ComplianceRule' description: '' patch: operationId: compliance_rules_partial_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance rule. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedComplianceRule' multipart/form-data: schema: $ref: '#/components/schemas/PatchedComplianceRule' application/json: schema: $ref: '#/components/schemas/PatchedComplianceRule' application/xml: schema: $ref: '#/components/schemas/PatchedComplianceRule' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceRule' application/xml: schema: $ref: '#/components/schemas/ComplianceRule' description: '' delete: operationId: compliance_rules_destroy description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance rule. required: true tags: - compliance security: - knoxApiToken: [] responses: '204': description: No response body /compliance/rules/context-fields/: get: operationId: compliance_rules_context_fields_retrieve description: |- Expose the compliance rule context schema for the rule editor. Mirrors automation's TriggerViewSet: returns the extra (non-model) context fields available to compliance rules — currently the software group — so the frontend builds the field list from the backend instead of hard-coding it. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceRule' application/xml: schema: $ref: '#/components/schemas/ComplianceRule' description: '' /compliance/types/: get: operationId: compliance_types_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedComplianceTypeList' application/xml: schema: $ref: '#/components/schemas/PaginatedComplianceTypeList' description: '' post: operationId: compliance_types_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComplianceType' multipart/form-data: schema: $ref: '#/components/schemas/ComplianceType' application/json: schema: $ref: '#/components/schemas/ComplianceType' application/xml: schema: $ref: '#/components/schemas/ComplianceType' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ComplianceType' application/xml: schema: $ref: '#/components/schemas/ComplianceType' description: '' /compliance/types/{id}/: get: operationId: compliance_types_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance type. required: true tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceType' application/xml: schema: $ref: '#/components/schemas/ComplianceType' description: '' put: operationId: compliance_types_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance type. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ComplianceType' multipart/form-data: schema: $ref: '#/components/schemas/ComplianceType' application/json: schema: $ref: '#/components/schemas/ComplianceType' application/xml: schema: $ref: '#/components/schemas/ComplianceType' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceType' application/xml: schema: $ref: '#/components/schemas/ComplianceType' description: '' patch: operationId: compliance_types_partial_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance type. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedComplianceType' multipart/form-data: schema: $ref: '#/components/schemas/PatchedComplianceType' application/json: schema: $ref: '#/components/schemas/PatchedComplianceType' application/xml: schema: $ref: '#/components/schemas/PatchedComplianceType' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComplianceType' application/xml: schema: $ref: '#/components/schemas/ComplianceType' description: '' delete: operationId: compliance_types_destroy description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this compliance type. required: true tags: - compliance security: - knoxApiToken: [] responses: '204': description: No response body /compliance/windows-build-mapping/: get: operationId: compliance_windows_build_mapping_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: build schema: type: integer - in: query name: channel schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedWindowsBuildMappingList' application/xml: schema: $ref: '#/components/schemas/PaginatedWindowsBuildMappingList' description: '' post: operationId: compliance_windows_build_mapping_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WindowsBuildMapping' multipart/form-data: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/json: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/xml: schema: $ref: '#/components/schemas/WindowsBuildMapping' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/xml: schema: $ref: '#/components/schemas/WindowsBuildMapping' description: '' /compliance/windows-build-mapping/{id}/: get: operationId: compliance_windows_build_mapping_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this windows build mapping. required: true tags: - compliance security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/xml: schema: $ref: '#/components/schemas/WindowsBuildMapping' description: '' put: operationId: compliance_windows_build_mapping_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this windows build mapping. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WindowsBuildMapping' multipart/form-data: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/json: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/xml: schema: $ref: '#/components/schemas/WindowsBuildMapping' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/xml: schema: $ref: '#/components/schemas/WindowsBuildMapping' description: '' patch: operationId: compliance_windows_build_mapping_partial_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this windows build mapping. required: true tags: - compliance requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedWindowsBuildMapping' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWindowsBuildMapping' application/json: schema: $ref: '#/components/schemas/PatchedWindowsBuildMapping' application/xml: schema: $ref: '#/components/schemas/PatchedWindowsBuildMapping' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WindowsBuildMapping' application/xml: schema: $ref: '#/components/schemas/WindowsBuildMapping' description: '' delete: operationId: compliance_windows_build_mapping_destroy description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this windows build mapping. required: true tags: - compliance security: - knoxApiToken: [] responses: '204': description: No response body /config/: get: operationId: config_list description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - config security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedConfigList' application/xml: schema: $ref: '#/components/schemas/PaginatedConfigList' description: '' post: operationId: config_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - config requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Config' multipart/form-data: schema: $ref: '#/components/schemas/Config' application/json: schema: $ref: '#/components/schemas/Config' application/xml: schema: $ref: '#/components/schemas/Config' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Config' application/xml: schema: $ref: '#/components/schemas/Config' description: '' /config/{name}/: get: operationId: config_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: name schema: type: string description: A unique value identifying this config. required: true tags: - config security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Config' application/xml: schema: $ref: '#/components/schemas/Config' description: '' put: operationId: config_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: name schema: type: string description: A unique value identifying this config. required: true tags: - config requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Config' multipart/form-data: schema: $ref: '#/components/schemas/Config' application/json: schema: $ref: '#/components/schemas/Config' application/xml: schema: $ref: '#/components/schemas/Config' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Config' application/xml: schema: $ref: '#/components/schemas/Config' description: '' patch: operationId: config_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: name schema: type: string description: A unique value identifying this config. required: true tags: - config requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedConfig' multipart/form-data: schema: $ref: '#/components/schemas/PatchedConfig' application/json: schema: $ref: '#/components/schemas/PatchedConfig' application/xml: schema: $ref: '#/components/schemas/PatchedConfig' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Config' application/xml: schema: $ref: '#/components/schemas/Config' description: '' delete: operationId: config_destroy description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: name schema: type: string description: A unique value identifying this config. required: true tags: - config security: - knoxApiToken: [] responses: '204': description: No response body /dashboard/chart/: get: operationId: dashboard_chart_list description: Return the list of available dashboard charts. parameters: - in: query name: agent schema: type: string - in: query name: description schema: type: string - in: query name: domain schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: is_template_forced schema: type: boolean - in: query name: last_update schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: osname schema: type: string - in: query name: osversion schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: serial schema: type: string - in: query name: srcip schema: type: string - in: query name: srcmac schema: type: string - in: query name: template schema: type: integer - in: query name: uuid schema: type: string tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDashboardChartDescriptorList' application/xml: schema: $ref: '#/components/schemas/PaginatedDashboardChartDescriptorList' description: '' post: operationId: dashboard_chart_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DashboardChartDescriptor' multipart/form-data: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/json: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/xml: schema: $ref: '#/components/schemas/DashboardChartDescriptor' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/xml: schema: $ref: '#/components/schemas/DashboardChartDescriptor' description: '' /dashboard/chart/{id}/: get: operationId: dashboard_chart_retrieve description: This class allows the frontend to request data for the dashboard charts parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/xml: schema: $ref: '#/components/schemas/DashboardChartDescriptor' description: '' put: operationId: dashboard_chart_update description: This class allows the frontend to request data for the dashboard charts parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - dashboard requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DashboardChartDescriptor' multipart/form-data: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/json: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/xml: schema: $ref: '#/components/schemas/DashboardChartDescriptor' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/xml: schema: $ref: '#/components/schemas/DashboardChartDescriptor' description: '' patch: operationId: dashboard_chart_partial_update description: This class allows the frontend to request data for the dashboard charts parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - dashboard requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedDashboardChartDescriptor' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDashboardChartDescriptor' application/json: schema: $ref: '#/components/schemas/PatchedDashboardChartDescriptor' application/xml: schema: $ref: '#/components/schemas/PatchedDashboardChartDescriptor' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartDescriptor' application/xml: schema: $ref: '#/components/schemas/DashboardChartDescriptor' description: '' delete: operationId: dashboard_chart_destroy description: This class allows the frontend to request data for the dashboard charts parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this inventory base. required: true tags: - dashboard security: - knoxApiToken: [] responses: '204': description: No response body /dashboard/chart/lastcontacted/: get: operationId: dashboard_chart_lastcontacted_retrieve description: Devices count per last contacted date (7 days). parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartSeries' application/xml: schema: $ref: '#/components/schemas/DashboardChartSeries' description: '' /dashboard/chart/nb_netdevices/: get: operationId: dashboard_chart_nb_netdevices_retrieve description: Total netdevices count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartTotal' application/xml: schema: $ref: '#/components/schemas/DashboardChartTotal' description: '' /dashboard/chart/nb_networks/: get: operationId: dashboard_chart_nb_networks_retrieve description: Total networks count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartTotal' application/xml: schema: $ref: '#/components/schemas/DashboardChartTotal' description: '' /dashboard/chart/networks/: get: operationId: dashboard_chart_networks_retrieve description: Devices count per network. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartSeries' application/xml: schema: $ref: '#/components/schemas/DashboardChartSeries' description: '' /dashboard/chart/oscount/: get: operationId: dashboard_chart_oscount_retrieve description: Unique OS names and their associated count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartSeries' application/xml: schema: $ref: '#/components/schemas/DashboardChartSeries' description: '' /dashboard/chart/total_ALL/: get: operationId: dashboard_chart_total_ALL_retrieve description: Total devices count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartCounter' application/xml: schema: $ref: '#/components/schemas/DashboardChartCounter' description: '' /dashboard/chart/total_LEG/: get: operationId: dashboard_chart_total_LEG_retrieve description: Total Legacy devices count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartCounter' application/xml: schema: $ref: '#/components/schemas/DashboardChartCounter' description: '' /dashboard/chart/total_LIN/: get: operationId: dashboard_chart_total_LIN_retrieve description: Total Linux devices count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartCounter' application/xml: schema: $ref: '#/components/schemas/DashboardChartCounter' description: '' /dashboard/chart/total_MAC/: get: operationId: dashboard_chart_total_MAC_retrieve description: Total MacOS devices count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartCounter' application/xml: schema: $ref: '#/components/schemas/DashboardChartCounter' description: '' /dashboard/chart/total_SNMP/: get: operationId: dashboard_chart_total_SNMP_retrieve description: Total SNMP devices count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartCounter' application/xml: schema: $ref: '#/components/schemas/DashboardChartCounter' description: '' /dashboard/chart/total_WIN/: get: operationId: dashboard_chart_total_WIN_retrieve description: Total Windows devices count. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardChartCounter' application/xml: schema: $ref: '#/components/schemas/DashboardChartCounter' description: '' /dashboard/layout/: get: operationId: dashboard_layout_list description: |- this class will permit the frontend server to manage configuration for the dashboard. parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDashboardLayoutList' application/xml: schema: $ref: '#/components/schemas/PaginatedDashboardLayoutList' description: '' post: operationId: dashboard_layout_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - dashboard requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DashboardLayout' multipart/form-data: schema: $ref: '#/components/schemas/DashboardLayout' application/json: schema: $ref: '#/components/schemas/DashboardLayout' application/xml: schema: $ref: '#/components/schemas/DashboardLayout' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DashboardLayout' application/xml: schema: $ref: '#/components/schemas/DashboardLayout' description: '' /dashboard/layout/{id}/: get: operationId: dashboard_layout_retrieve description: |- this class will permit the frontend server to manage configuration for the dashboard. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this dashboard layout. required: true tags: - dashboard security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardLayout' application/xml: schema: $ref: '#/components/schemas/DashboardLayout' description: '' put: operationId: dashboard_layout_update description: |- User needs to either be the creator or part of the group (if allow_group_modification is enabled) to modify a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this dashboard layout. required: true tags: - dashboard requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DashboardLayout' multipart/form-data: schema: $ref: '#/components/schemas/DashboardLayout' application/json: schema: $ref: '#/components/schemas/DashboardLayout' application/xml: schema: $ref: '#/components/schemas/DashboardLayout' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardLayout' application/xml: schema: $ref: '#/components/schemas/DashboardLayout' description: '' patch: operationId: dashboard_layout_partial_update description: |- this class will permit the frontend server to manage configuration for the dashboard. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this dashboard layout. required: true tags: - dashboard requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedDashboardLayout' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDashboardLayout' application/json: schema: $ref: '#/components/schemas/PatchedDashboardLayout' application/xml: schema: $ref: '#/components/schemas/PatchedDashboardLayout' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DashboardLayout' application/xml: schema: $ref: '#/components/schemas/DashboardLayout' description: '' delete: operationId: dashboard_layout_destroy description: User needs to be the creator to delete a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this dashboard layout. required: true tags: - dashboard security: - knoxApiToken: [] responses: '204': description: No response body /debug/resolve/: post: operationId: debug_resolve_create description: Resolve API calls made by a frontend page into the permissions they require, used by the frontend debug mode. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - debug requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DebugResolve' multipart/form-data: schema: $ref: '#/components/schemas/DebugResolve' application/json: schema: $ref: '#/components/schemas/DebugResolve' application/xml: schema: $ref: '#/components/schemas/DebugResolve' required: true security: - knoxApiToken: [] responses: '200': description: No response body /deployment/actions/: get: operationId: deployment_actions_list description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: action_type schema: type: string - in: query name: command schema: type: string - in: query name: date_created schema: type: string format: date-time - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: package schema: type: integer - in: query name: priority schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - deployment security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedActionList' application/xml: schema: $ref: '#/components/schemas/PaginatedActionList' description: '' post: operationId: deployment_actions_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Action' multipart/form-data: schema: $ref: '#/components/schemas/Action' application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' /deployment/actions/{id}/: get: operationId: deployment_actions_retrieve description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this deployment action. required: true tags: - deployment security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' put: operationId: deployment_actions_update description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this deployment action. required: true tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Action' multipart/form-data: schema: $ref: '#/components/schemas/Action' application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' patch: operationId: deployment_actions_partial_update description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this deployment action. required: true tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAction' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAction' application/json: schema: $ref: '#/components/schemas/PatchedAction' application/xml: schema: $ref: '#/components/schemas/PatchedAction' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Action' application/xml: schema: $ref: '#/components/schemas/Action' description: '' delete: operationId: deployment_actions_destroy description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this deployment action. required: true tags: - deployment security: - knoxApiToken: [] responses: '204': description: No response body /deployment/packages/: get: operationId: deployment_packages_list description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: date_created schema: type: string format: date-time - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: target_os schema: type: string enum: - LIN - MAC - WIN description: |- * `WIN` - Windows * `LIN` - Linux * `MAC` - Mac tags: - deployment security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPackageList' application/xml: schema: $ref: '#/components/schemas/PaginatedPackageList' description: '' post: operationId: deployment_packages_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Package' multipart/form-data: schema: $ref: '#/components/schemas/Package' application/json: schema: $ref: '#/components/schemas/Package' application/xml: schema: $ref: '#/components/schemas/Package' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Package' application/xml: schema: $ref: '#/components/schemas/Package' description: '' /deployment/packages/{id}/: get: operationId: deployment_packages_retrieve description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this package. required: true tags: - deployment security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Package' application/xml: schema: $ref: '#/components/schemas/Package' description: '' put: operationId: deployment_packages_update description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this package. required: true tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Package' multipart/form-data: schema: $ref: '#/components/schemas/Package' application/json: schema: $ref: '#/components/schemas/Package' application/xml: schema: $ref: '#/components/schemas/Package' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Package' application/xml: schema: $ref: '#/components/schemas/Package' description: '' patch: operationId: deployment_packages_partial_update description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this package. required: true tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPackage' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPackage' application/json: schema: $ref: '#/components/schemas/PatchedPackage' application/xml: schema: $ref: '#/components/schemas/PatchedPackage' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Package' application/xml: schema: $ref: '#/components/schemas/Package' description: '' delete: operationId: deployment_packages_destroy description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this package. required: true tags: - deployment security: - knoxApiToken: [] responses: '204': description: No response body /deployment/results/: get: operationId: deployment_results_list description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: asset schema: type: integer - in: query name: comment schema: type: string - in: query name: date_created schema: type: string format: date-time - in: query name: format schema: type: string enum: - json - xml - in: query name: group schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: package schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: status schema: type: integer enum: - 0 - 1 - 2 - 3 description: |- * `0` - Sucess * `1` - Waiting notification * `2` - Notified * `3` - Error tags: - deployment security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedResultList' application/xml: schema: $ref: '#/components/schemas/PaginatedResultList' description: '' post: operationId: deployment_results_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Result' multipart/form-data: schema: $ref: '#/components/schemas/Result' application/json: schema: $ref: '#/components/schemas/Result' application/xml: schema: $ref: '#/components/schemas/Result' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Result' application/xml: schema: $ref: '#/components/schemas/Result' description: '' /deployment/results/{id}/: get: operationId: deployment_results_retrieve description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this result. required: true tags: - deployment security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Result' application/xml: schema: $ref: '#/components/schemas/Result' description: '' put: operationId: deployment_results_update description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this result. required: true tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Result' multipart/form-data: schema: $ref: '#/components/schemas/Result' application/json: schema: $ref: '#/components/schemas/Result' application/xml: schema: $ref: '#/components/schemas/Result' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Result' application/xml: schema: $ref: '#/components/schemas/Result' description: '' patch: operationId: deployment_results_partial_update description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this result. required: true tags: - deployment requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedResult' multipart/form-data: schema: $ref: '#/components/schemas/PatchedResult' application/json: schema: $ref: '#/components/schemas/PatchedResult' application/xml: schema: $ref: '#/components/schemas/PatchedResult' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Result' application/xml: schema: $ref: '#/components/schemas/Result' description: '' delete: operationId: deployment_results_destroy description: |- View behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this result. required: true tags: - deployment security: - knoxApiToken: [] responses: '204': description: No response body /extensions/: get: operationId: extensions_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: author schema: type: string - in: query name: description schema: type: string - in: query name: django_app schema: type: string - in: query name: enabled schema: type: boolean - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: version schema: type: string tags: - extensions security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExtensionList' application/xml: schema: $ref: '#/components/schemas/PaginatedExtensionList' description: '' post: operationId: extensions_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - extensions requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Extension' multipart/form-data: schema: $ref: '#/components/schemas/Extension' application/json: schema: $ref: '#/components/schemas/Extension' application/xml: schema: $ref: '#/components/schemas/Extension' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Extension' application/xml: schema: $ref: '#/components/schemas/Extension' description: '' /extensions/{id}/: get: operationId: extensions_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this extension. required: true tags: - extensions security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' application/xml: schema: $ref: '#/components/schemas/Extension' description: '' put: operationId: extensions_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this extension. required: true tags: - extensions requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Extension' multipart/form-data: schema: $ref: '#/components/schemas/Extension' application/json: schema: $ref: '#/components/schemas/Extension' application/xml: schema: $ref: '#/components/schemas/Extension' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' application/xml: schema: $ref: '#/components/schemas/Extension' description: '' patch: operationId: extensions_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this extension. required: true tags: - extensions requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedExtension' multipart/form-data: schema: $ref: '#/components/schemas/PatchedExtension' application/json: schema: $ref: '#/components/schemas/PatchedExtension' application/xml: schema: $ref: '#/components/schemas/PatchedExtension' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' application/xml: schema: $ref: '#/components/schemas/Extension' description: '' delete: operationId: extensions_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this extension. required: true tags: - extensions security: - knoxApiToken: [] responses: '204': description: No response body /extensions/enabled/: get: operationId: extensions_enabled_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml tags: - extensions security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Extension' application/xml: schema: $ref: '#/components/schemas/Extension' description: '' /fields/: get: operationId: fields_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - in: query name: new_target schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: order schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: override_target schema: type: boolean - in: query name: retrieval_method schema: type: string nullable: true enum: - BASH - CMD - FILE - PW description: |- * `FILE` - Read file * `BASH` - Bash command * `PW` - Powershell command * `CMD` - Cmd command - in: query name: retrieval_output schema: type: string nullable: true enum: - GREP - JSON - PTXT - REGX - TBLE description: |- * `PTXT` - Plain text * `JSON` - JSON format * `TBLE` - Table format * `REGX` - Regex processing * `GREP` - Grep command output - in: query name: retrieval_value schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: section schema: type: number tags: - fields security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFieldList' application/xml: schema: $ref: '#/components/schemas/PaginatedFieldList' description: '' post: operationId: fields_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - fields requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Field' multipart/form-data: schema: $ref: '#/components/schemas/Field' application/json: schema: $ref: '#/components/schemas/Field' application/xml: schema: $ref: '#/components/schemas/Field' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Field' application/xml: schema: $ref: '#/components/schemas/Field' description: '' /fields/{id}/: get: operationId: fields_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this field. required: true tags: - fields security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Field' application/xml: schema: $ref: '#/components/schemas/Field' description: '' put: operationId: fields_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this field. required: true tags: - fields requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Field' multipart/form-data: schema: $ref: '#/components/schemas/Field' application/json: schema: $ref: '#/components/schemas/Field' application/xml: schema: $ref: '#/components/schemas/Field' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Field' application/xml: schema: $ref: '#/components/schemas/Field' description: '' patch: operationId: fields_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this field. required: true tags: - fields requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedField' multipart/form-data: schema: $ref: '#/components/schemas/PatchedField' application/json: schema: $ref: '#/components/schemas/PatchedField' application/xml: schema: $ref: '#/components/schemas/PatchedField' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Field' application/xml: schema: $ref: '#/components/schemas/Field' description: '' delete: operationId: fields_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this field. required: true tags: - fields security: - knoxApiToken: [] responses: '204': description: No response body /filemanager/: get: operationId: filemanager_list description: Viewset for the FileManager model. parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - filemanager security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFileManagerList' application/xml: schema: $ref: '#/components/schemas/PaginatedFileManagerList' description: '' post: operationId: filemanager_create description: Viewset for the FileManager model. parameters: - in: query name: format schema: type: string enum: - json - xml tags: - filemanager requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FileManager' multipart/form-data: schema: $ref: '#/components/schemas/FileManager' application/json: schema: $ref: '#/components/schemas/FileManager' application/xml: schema: $ref: '#/components/schemas/FileManager' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FileManager' application/xml: schema: $ref: '#/components/schemas/FileManager' description: '' /filemanager/{id}/: get: operationId: filemanager_retrieve description: Viewset for the FileManager model. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this file manager. required: true tags: - filemanager security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FileManager' application/xml: schema: $ref: '#/components/schemas/FileManager' description: '' put: operationId: filemanager_update description: Viewset for the FileManager model. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this file manager. required: true tags: - filemanager requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FileManager' multipart/form-data: schema: $ref: '#/components/schemas/FileManager' application/json: schema: $ref: '#/components/schemas/FileManager' application/xml: schema: $ref: '#/components/schemas/FileManager' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FileManager' application/xml: schema: $ref: '#/components/schemas/FileManager' description: '' patch: operationId: filemanager_partial_update description: Viewset for the FileManager model. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this file manager. required: true tags: - filemanager requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedFileManager' multipart/form-data: schema: $ref: '#/components/schemas/PatchedFileManager' application/json: schema: $ref: '#/components/schemas/PatchedFileManager' application/xml: schema: $ref: '#/components/schemas/PatchedFileManager' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FileManager' application/xml: schema: $ref: '#/components/schemas/FileManager' description: '' delete: operationId: filemanager_destroy description: Viewset for the FileManager model. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this file manager. required: true tags: - filemanager security: - knoxApiToken: [] responses: '204': description: No response body /groups/: get: operationId: groups_list description: |- This class will define the view behavior Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: permissions schema: type: array items: type: integer explode: true style: form - name: search required: false in: query description: A search term. schema: type: string tags: - groups security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupList' application/xml: schema: $ref: '#/components/schemas/PaginatedGroupList' description: '' post: operationId: groups_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - groups requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Group' multipart/form-data: schema: $ref: '#/components/schemas/Group' application/json: schema: $ref: '#/components/schemas/Group' application/xml: schema: $ref: '#/components/schemas/Group' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Group' application/xml: schema: $ref: '#/components/schemas/Group' description: '' /groups/{id}/: get: operationId: groups_retrieve description: |- This class will define the view behavior Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - groups security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' application/xml: schema: $ref: '#/components/schemas/Group' description: '' put: operationId: groups_update description: |- This class will define the view behavior Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - groups requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Group' multipart/form-data: schema: $ref: '#/components/schemas/Group' application/json: schema: $ref: '#/components/schemas/Group' application/xml: schema: $ref: '#/components/schemas/Group' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' application/xml: schema: $ref: '#/components/schemas/Group' description: '' patch: operationId: groups_partial_update description: |- This class will define the view behavior Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - groups requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedGroup' multipart/form-data: schema: $ref: '#/components/schemas/PatchedGroup' application/json: schema: $ref: '#/components/schemas/PatchedGroup' application/xml: schema: $ref: '#/components/schemas/PatchedGroup' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' application/xml: schema: $ref: '#/components/schemas/Group' description: '' delete: operationId: groups_destroy description: |- This class will define the view behavior Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this group. required: true tags: - groups security: - knoxApiToken: [] responses: '204': description: No response body /myaccount/: get: operationId: myaccount_list description: Dedicated my account json response parameters: - in: query name: date_joined schema: type: string format: date-time - in: query name: email schema: type: string - in: query name: first_name schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: groups schema: type: array items: type: integer explode: true style: form - in: query name: is_active schema: type: boolean - in: query name: is_staff schema: type: boolean - in: query name: is_superuser schema: type: boolean - in: query name: last_login schema: type: string format: date-time - in: query name: last_name schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: password schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: user_permissions schema: type: array items: type: integer explode: true style: form - in: query name: username schema: type: string tags: - myaccount security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedMyAccountList' application/xml: schema: $ref: '#/components/schemas/PaginatedMyAccountList' description: '' /myaccount/{id}/: get: operationId: myaccount_retrieve description: This class will define the view behavior parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - myaccount security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MyAccount' application/xml: schema: $ref: '#/components/schemas/MyAccount' description: '' patch: operationId: myaccount_partial_update description: This class will define the view behavior parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - myaccount requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedMyAccount' multipart/form-data: schema: $ref: '#/components/schemas/PatchedMyAccount' application/json: schema: $ref: '#/components/schemas/PatchedMyAccount' application/xml: schema: $ref: '#/components/schemas/PatchedMyAccount' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MyAccount' application/xml: schema: $ref: '#/components/schemas/MyAccount' description: '' /netdevices/: get: operationId: netdevices_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: ip schema: type: string - in: query name: last_seen schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: mac schema: type: string - in: query name: netname schema: type: string - in: query name: network schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - netdevices security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNetdeviceList' application/xml: schema: $ref: '#/components/schemas/PaginatedNetdeviceList' description: '' post: operationId: netdevices_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - netdevices requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Netdevice' multipart/form-data: schema: $ref: '#/components/schemas/Netdevice' application/json: schema: $ref: '#/components/schemas/Netdevice' application/xml: schema: $ref: '#/components/schemas/Netdevice' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Netdevice' application/xml: schema: $ref: '#/components/schemas/Netdevice' description: '' /netdevices/{id}/: get: operationId: netdevices_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netdevice. required: true tags: - netdevices security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Netdevice' application/xml: schema: $ref: '#/components/schemas/Netdevice' description: '' put: operationId: netdevices_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netdevice. required: true tags: - netdevices requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Netdevice' multipart/form-data: schema: $ref: '#/components/schemas/Netdevice' application/json: schema: $ref: '#/components/schemas/Netdevice' application/xml: schema: $ref: '#/components/schemas/Netdevice' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Netdevice' application/xml: schema: $ref: '#/components/schemas/Netdevice' description: '' patch: operationId: netdevices_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netdevice. required: true tags: - netdevices requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedNetdevice' multipart/form-data: schema: $ref: '#/components/schemas/PatchedNetdevice' application/json: schema: $ref: '#/components/schemas/PatchedNetdevice' application/xml: schema: $ref: '#/components/schemas/PatchedNetdevice' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Netdevice' application/xml: schema: $ref: '#/components/schemas/Netdevice' description: '' delete: operationId: netdevices_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netdevice. required: true tags: - netdevices security: - knoxApiToken: [] responses: '204': description: No response body /netgroups/: get: operationId: netgroups_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - netgroups security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNetgroupList' application/xml: schema: $ref: '#/components/schemas/PaginatedNetgroupList' description: '' post: operationId: netgroups_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - netgroups requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Netgroup' multipart/form-data: schema: $ref: '#/components/schemas/Netgroup' application/json: schema: $ref: '#/components/schemas/Netgroup' application/xml: schema: $ref: '#/components/schemas/Netgroup' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Netgroup' application/xml: schema: $ref: '#/components/schemas/Netgroup' description: '' /netgroups/{id}/: get: operationId: netgroups_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netgroup. required: true tags: - netgroups security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Netgroup' application/xml: schema: $ref: '#/components/schemas/Netgroup' description: '' put: operationId: netgroups_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netgroup. required: true tags: - netgroups requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Netgroup' multipart/form-data: schema: $ref: '#/components/schemas/Netgroup' application/json: schema: $ref: '#/components/schemas/Netgroup' application/xml: schema: $ref: '#/components/schemas/Netgroup' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Netgroup' application/xml: schema: $ref: '#/components/schemas/Netgroup' description: '' patch: operationId: netgroups_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netgroup. required: true tags: - netgroups requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedNetgroup' multipart/form-data: schema: $ref: '#/components/schemas/PatchedNetgroup' application/json: schema: $ref: '#/components/schemas/PatchedNetgroup' application/xml: schema: $ref: '#/components/schemas/PatchedNetgroup' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Netgroup' application/xml: schema: $ref: '#/components/schemas/Netgroup' description: '' delete: operationId: netgroups_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this netgroup. required: true tags: - netgroups security: - knoxApiToken: [] responses: '204': description: No response body /networks/: get: operationId: networks_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: group schema: type: integer - in: query name: last_update schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: string - in: query name: mask schema: type: string - in: query name: name schema: type: string - in: query name: netid schema: type: string - in: query name: nettag schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - networks security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNetworkList' application/xml: schema: $ref: '#/components/schemas/PaginatedNetworkList' description: '' post: operationId: networks_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - networks requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Network' multipart/form-data: schema: $ref: '#/components/schemas/Network' application/json: schema: $ref: '#/components/schemas/Network' application/xml: schema: $ref: '#/components/schemas/Network' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Network' application/xml: schema: $ref: '#/components/schemas/Network' description: '' /networks/{id}/: get: operationId: networks_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this network. required: true tags: - networks security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Network' application/xml: schema: $ref: '#/components/schemas/Network' description: '' put: operationId: networks_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this network. required: true tags: - networks requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Network' multipart/form-data: schema: $ref: '#/components/schemas/Network' application/json: schema: $ref: '#/components/schemas/Network' application/xml: schema: $ref: '#/components/schemas/Network' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Network' application/xml: schema: $ref: '#/components/schemas/Network' description: '' patch: operationId: networks_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this network. required: true tags: - networks requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedNetwork' multipart/form-data: schema: $ref: '#/components/schemas/PatchedNetwork' application/json: schema: $ref: '#/components/schemas/PatchedNetwork' application/xml: schema: $ref: '#/components/schemas/PatchedNetwork' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Network' application/xml: schema: $ref: '#/components/schemas/Network' description: '' delete: operationId: networks_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this network. required: true tags: - networks security: - knoxApiToken: [] responses: '204': description: No response body /notes/: get: operationId: notes_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: content_type schema: type: integer - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: object_id schema: type: integer - in: query name: object_slug schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - notes security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNoteList' application/xml: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' post: operationId: notes_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - notes requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Note' multipart/form-data: schema: $ref: '#/components/schemas/Note' application/json: schema: $ref: '#/components/schemas/Note' application/xml: schema: $ref: '#/components/schemas/Note' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Note' application/xml: schema: $ref: '#/components/schemas/Note' description: '' /notes/{id}/: get: operationId: notes_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this note. required: true tags: - notes security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Note' application/xml: schema: $ref: '#/components/schemas/Note' description: '' put: operationId: notes_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this note. required: true tags: - notes requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Note' multipart/form-data: schema: $ref: '#/components/schemas/Note' application/json: schema: $ref: '#/components/schemas/Note' application/xml: schema: $ref: '#/components/schemas/Note' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Note' application/xml: schema: $ref: '#/components/schemas/Note' description: '' patch: operationId: notes_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this note. required: true tags: - notes requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedNote' multipart/form-data: schema: $ref: '#/components/schemas/PatchedNote' application/json: schema: $ref: '#/components/schemas/PatchedNote' application/xml: schema: $ref: '#/components/schemas/PatchedNote' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Note' application/xml: schema: $ref: '#/components/schemas/Note' description: '' delete: operationId: notes_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this note. required: true tags: - notes security: - knoxApiToken: [] responses: '204': description: No response body /permissions/: get: operationId: permissions_list description: |- This class will define the view behavior Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - permissions security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPermissionList' application/xml: schema: $ref: '#/components/schemas/PaginatedPermissionList' description: '' /permissions/{id}/: get: operationId: permissions_retrieve description: |- This class will define the view behavior Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this permission. required: true tags: - permissions security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Permission' application/xml: schema: $ref: '#/components/schemas/Permission' description: '' /search/: post: operationId: search_create description: Run a multi-condition search across assets and their related data (results, logs, snmpscanner, inventory_sections, software_dictionary_entries). parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - search requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SearchRequest' multipart/form-data: schema: $ref: '#/components/schemas/SearchRequest' application/json: schema: $ref: '#/components/schemas/SearchRequest' application/xml: schema: $ref: '#/components/schemas/SearchRequest' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryBaseList' application/xml: schema: $ref: '#/components/schemas/PaginatedInventoryBaseList' description: '' '500': content: application/json: schema: $ref: '#/components/schemas/SearchError' application/xml: schema: $ref: '#/components/schemas/SearchError' description: '' /search/save/: get: operationId: search_save_list description: |- This class will define the view behavior Inherits from RestrictVisibilityViewSet to restrict the visibility of the Search objects based on user and group membership Args: viewsets ([OCSVIewSet]) parameters: - in: query name: description schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - in: query name: last_updated schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string tags: - search security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSearchList' application/xml: schema: $ref: '#/components/schemas/PaginatedSearchList' description: '' post: operationId: search_save_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - search requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Search' multipart/form-data: schema: $ref: '#/components/schemas/Search' application/json: schema: $ref: '#/components/schemas/Search' application/xml: schema: $ref: '#/components/schemas/Search' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Search' application/xml: schema: $ref: '#/components/schemas/Search' description: '' /search/save/{id}/: get: operationId: search_save_retrieve description: |- This class will define the view behavior Inherits from RestrictVisibilityViewSet to restrict the visibility of the Search objects based on user and group membership Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this search. required: true tags: - search security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Search' application/xml: schema: $ref: '#/components/schemas/Search' description: '' put: operationId: search_save_update description: |- User needs to either be the creator or part of the group (if allow_group_modification is enabled) to modify a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this search. required: true tags: - search requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Search' multipart/form-data: schema: $ref: '#/components/schemas/Search' application/json: schema: $ref: '#/components/schemas/Search' application/xml: schema: $ref: '#/components/schemas/Search' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Search' application/xml: schema: $ref: '#/components/schemas/Search' description: '' patch: operationId: search_save_partial_update description: |- This class will define the view behavior Inherits from RestrictVisibilityViewSet to restrict the visibility of the Search objects based on user and group membership Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this search. required: true tags: - search requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedSearch' multipart/form-data: schema: $ref: '#/components/schemas/PatchedSearch' application/json: schema: $ref: '#/components/schemas/PatchedSearch' application/xml: schema: $ref: '#/components/schemas/PatchedSearch' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Search' application/xml: schema: $ref: '#/components/schemas/Search' description: '' delete: operationId: search_save_destroy description: User needs to be the creator to delete a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this search. required: true tags: - search security: - knoxApiToken: [] responses: '204': description: No response body /sections/: get: operationId: sections_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - in: query name: is_active schema: type: boolean - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: retrieval_method schema: type: string enum: - BASH - CMD - FILE - PW - SNMP_GET - SNMP_WALK description: |- * `FILE` - Read file * `BASH` - Bash command * `PW` - Powershell command * `CMD` - Cmd command * `SNMP_WALK` - Walk the SNMP tree starting from a specific OID * `SNMP_GET` - Get a specific OID - in: query name: retrieval_output schema: type: string enum: - GREP - JSON - PTXT - REGX - TBLE description: |- * `PTXT` - Plain text * `JSON` - JSON format * `TBLE` - Table format * `REGX` - Regex processing * `GREP` - Grep command output - name: search required: false in: query description: A search term. schema: type: string - in: query name: target schema: type: string - in: query name: template schema: type: integer tags: - sections security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSectionList' application/xml: schema: $ref: '#/components/schemas/PaginatedSectionList' description: '' post: operationId: sections_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - sections requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Section' multipart/form-data: schema: $ref: '#/components/schemas/Section' application/json: schema: $ref: '#/components/schemas/Section' application/xml: schema: $ref: '#/components/schemas/Section' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Section' application/xml: schema: $ref: '#/components/schemas/Section' description: '' /sections/{id}/: get: operationId: sections_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this section. required: true tags: - sections security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Section' application/xml: schema: $ref: '#/components/schemas/Section' description: '' put: operationId: sections_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this section. required: true tags: - sections requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Section' multipart/form-data: schema: $ref: '#/components/schemas/Section' application/json: schema: $ref: '#/components/schemas/Section' application/xml: schema: $ref: '#/components/schemas/Section' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Section' application/xml: schema: $ref: '#/components/schemas/Section' description: '' patch: operationId: sections_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this section. required: true tags: - sections requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedSection' multipart/form-data: schema: $ref: '#/components/schemas/PatchedSection' application/json: schema: $ref: '#/components/schemas/PatchedSection' application/xml: schema: $ref: '#/components/schemas/PatchedSection' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Section' application/xml: schema: $ref: '#/components/schemas/Section' description: '' delete: operationId: sections_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this section. required: true tags: - sections security: - knoxApiToken: [] responses: '204': description: No response body /server-info/: get: operationId: server_info_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - server-info security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedServerInfoList' application/xml: schema: $ref: '#/components/schemas/PaginatedServerInfoList' description: '' /server-info/{name}/: get: operationId: server_info_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: name schema: type: string description: A unique value identifying this config. required: true tags: - server-info security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServerInfo' application/xml: schema: $ref: '#/components/schemas/ServerInfo' description: '' /snmp/config/: get: operationId: snmp_config_list description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - snmp security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSnmpConfigList' application/xml: schema: $ref: '#/components/schemas/PaginatedSnmpConfigList' description: '' post: operationId: snmp_config_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - snmp requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SnmpConfig' multipart/form-data: schema: $ref: '#/components/schemas/SnmpConfig' application/json: schema: $ref: '#/components/schemas/SnmpConfig' application/xml: schema: $ref: '#/components/schemas/SnmpConfig' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SnmpConfig' application/xml: schema: $ref: '#/components/schemas/SnmpConfig' description: '' /snmp/config/{id}/: get: operationId: snmp_config_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp config. required: true tags: - snmp security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SnmpConfig' application/xml: schema: $ref: '#/components/schemas/SnmpConfig' description: '' put: operationId: snmp_config_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp config. required: true tags: - snmp requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SnmpConfig' multipart/form-data: schema: $ref: '#/components/schemas/SnmpConfig' application/json: schema: $ref: '#/components/schemas/SnmpConfig' application/xml: schema: $ref: '#/components/schemas/SnmpConfig' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SnmpConfig' application/xml: schema: $ref: '#/components/schemas/SnmpConfig' description: '' patch: operationId: snmp_config_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp config. required: true tags: - snmp requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedSnmpConfig' multipart/form-data: schema: $ref: '#/components/schemas/PatchedSnmpConfig' application/json: schema: $ref: '#/components/schemas/PatchedSnmpConfig' application/xml: schema: $ref: '#/components/schemas/PatchedSnmpConfig' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SnmpConfig' application/xml: schema: $ref: '#/components/schemas/SnmpConfig' description: '' delete: operationId: snmp_config_destroy description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp config. required: true tags: - snmp security: - knoxApiToken: [] responses: '204': description: No response body /snmp/scanner/: get: operationId: snmp_scanner_list description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - snmp security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSnmpScannerList' application/xml: schema: $ref: '#/components/schemas/PaginatedSnmpScannerList' description: '' post: operationId: snmp_scanner_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - snmp requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SnmpScanner' multipart/form-data: schema: $ref: '#/components/schemas/SnmpScanner' application/json: schema: $ref: '#/components/schemas/SnmpScanner' application/xml: schema: $ref: '#/components/schemas/SnmpScanner' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SnmpScanner' application/xml: schema: $ref: '#/components/schemas/SnmpScanner' description: '' /snmp/scanner/{id}/: get: operationId: snmp_scanner_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp scanner. required: true tags: - snmp security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SnmpScanner' application/xml: schema: $ref: '#/components/schemas/SnmpScanner' description: '' put: operationId: snmp_scanner_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp scanner. required: true tags: - snmp requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SnmpScanner' multipart/form-data: schema: $ref: '#/components/schemas/SnmpScanner' application/json: schema: $ref: '#/components/schemas/SnmpScanner' application/xml: schema: $ref: '#/components/schemas/SnmpScanner' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SnmpScanner' application/xml: schema: $ref: '#/components/schemas/SnmpScanner' description: '' patch: operationId: snmp_scanner_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp scanner. required: true tags: - snmp requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedSnmpScanner' multipart/form-data: schema: $ref: '#/components/schemas/PatchedSnmpScanner' application/json: schema: $ref: '#/components/schemas/PatchedSnmpScanner' application/xml: schema: $ref: '#/components/schemas/PatchedSnmpScanner' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SnmpScanner' application/xml: schema: $ref: '#/components/schemas/SnmpScanner' description: '' delete: operationId: snmp_scanner_destroy description: |- This class will define the view behavior Args: viewsets ([OCSViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this snmp scanner. required: true tags: - snmp security: - knoxApiToken: [] responses: '204': description: No response body /software_dictionary/: get: operationId: software_dictionary_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - in: query name: installation_number schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: major_version schema: type: integer - in: query name: minor_version schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: patch_version schema: type: integer - in: query name: publisher schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: version schema: type: string tags: - software_dictionary security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSoftwareDictionaryList' application/xml: schema: $ref: '#/components/schemas/PaginatedSoftwareDictionaryList' description: '' post: operationId: software_dictionary_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - software_dictionary requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SoftwareDictionary' multipart/form-data: schema: $ref: '#/components/schemas/SoftwareDictionary' application/json: schema: $ref: '#/components/schemas/SoftwareDictionary' application/xml: schema: $ref: '#/components/schemas/SoftwareDictionary' security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SoftwareDictionary' application/xml: schema: $ref: '#/components/schemas/SoftwareDictionary' description: '' /software_dictionary/{id}/: get: operationId: software_dictionary_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software dictionary. required: true tags: - software_dictionary security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoftwareDictionary' application/xml: schema: $ref: '#/components/schemas/SoftwareDictionary' description: '' put: operationId: software_dictionary_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software dictionary. required: true tags: - software_dictionary requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SoftwareDictionary' multipart/form-data: schema: $ref: '#/components/schemas/SoftwareDictionary' application/json: schema: $ref: '#/components/schemas/SoftwareDictionary' application/xml: schema: $ref: '#/components/schemas/SoftwareDictionary' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoftwareDictionary' application/xml: schema: $ref: '#/components/schemas/SoftwareDictionary' description: '' patch: operationId: software_dictionary_partial_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software dictionary. required: true tags: - software_dictionary requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedSoftwareDictionary' multipart/form-data: schema: $ref: '#/components/schemas/PatchedSoftwareDictionary' application/json: schema: $ref: '#/components/schemas/PatchedSoftwareDictionary' application/xml: schema: $ref: '#/components/schemas/PatchedSoftwareDictionary' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoftwareDictionary' application/xml: schema: $ref: '#/components/schemas/SoftwareDictionary' description: '' delete: operationId: software_dictionary_destroy description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software dictionary. required: true tags: - software_dictionary security: - knoxApiToken: [] responses: '204': description: No response body /software_mapping/: get: operationId: software_mapping_list description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: major_version schema: type: integer - in: query name: minor_version schema: type: integer - in: query name: name schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: patch_version schema: type: integer - in: query name: publisher schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: section schema: type: integer - in: query name: template schema: type: integer - in: query name: version schema: type: integer tags: - software_mapping security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSoftwareMappingList' application/xml: schema: $ref: '#/components/schemas/PaginatedSoftwareMappingList' description: '' post: operationId: software_mapping_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - software_mapping requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SoftwareMapping' multipart/form-data: schema: $ref: '#/components/schemas/SoftwareMapping' application/json: schema: $ref: '#/components/schemas/SoftwareMapping' application/xml: schema: $ref: '#/components/schemas/SoftwareMapping' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SoftwareMapping' application/xml: schema: $ref: '#/components/schemas/SoftwareMapping' description: '' /software_mapping/{id}/: get: operationId: software_mapping_retrieve description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software mapping. required: true tags: - software_mapping security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoftwareMapping' application/xml: schema: $ref: '#/components/schemas/SoftwareMapping' description: '' put: operationId: software_mapping_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software mapping. required: true tags: - software_mapping requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SoftwareMapping' multipart/form-data: schema: $ref: '#/components/schemas/SoftwareMapping' application/json: schema: $ref: '#/components/schemas/SoftwareMapping' application/xml: schema: $ref: '#/components/schemas/SoftwareMapping' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoftwareMapping' application/xml: schema: $ref: '#/components/schemas/SoftwareMapping' description: '' patch: operationId: software_mapping_partial_update description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software mapping. required: true tags: - software_mapping requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedSoftwareMapping' multipart/form-data: schema: $ref: '#/components/schemas/PatchedSoftwareMapping' application/json: schema: $ref: '#/components/schemas/PatchedSoftwareMapping' application/xml: schema: $ref: '#/components/schemas/PatchedSoftwareMapping' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SoftwareMapping' application/xml: schema: $ref: '#/components/schemas/SoftwareMapping' description: '' delete: operationId: software_mapping_destroy description: |- This class will define the general view behavior for the framework Args: viewsets ([ModelViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this software mapping. required: true tags: - software_mapping security: - knoxApiToken: [] responses: '204': description: No response body /templates/: get: operationId: templates_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: is_protected schema: type: boolean - in: query name: last_update schema: type: string format: date-time - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: os schema: type: string enum: - DEB - LEG - MAC - RHEL - SNMP - VIRT - WIN description: |- * `LEG` - Legacy * `DEB` - Linux (Debian based) * `RHEL` - Linux (RHEL based) * `MAC` - Mac * `WIN` - Windows * `SNMP` - SNMP * `VIRT` - Virtualization - name: search required: false in: query description: A search term. schema: type: string tags: - templates security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTemplateList' application/xml: schema: $ref: '#/components/schemas/PaginatedTemplateList' description: '' post: operationId: templates_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - templates requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' multipart/form-data: schema: $ref: '#/components/schemas/Template' application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' /templates/{id}/: get: operationId: templates_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' put: operationId: templates_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' multipart/form-data: schema: $ref: '#/components/schemas/Template' application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' patch: operationId: templates_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTemplate' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTemplate' application/json: schema: $ref: '#/components/schemas/PatchedTemplate' application/xml: schema: $ref: '#/components/schemas/PatchedTemplate' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' delete: operationId: templates_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates security: - knoxApiToken: [] responses: '204': description: No response body /templates/{id}/export/: get: operationId: templates_export_retrieve description: |- Export a template and its nested sections and fields, using specific serializers to strip ids and fk relations parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' /templates/{id}/import-sections/: post: operationId: templates_import_sections_create description: |- Import (append) one or more sections, with their nested fields, into an existing template. Used by the partial template import: the sections come from an exported template file and are attached as brand new sections, so any provided id is dropped and the template is forced to the target one. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' multipart/form-data: schema: $ref: '#/components/schemas/Template' application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' /templates/{id}/versions/: get: operationId: templates_versions_retrieve description: List the version history for this template parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' post: operationId: templates_versions_create description: List the version history for this template parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true tags: - templates requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' multipart/form-data: schema: $ref: '#/components/schemas/Template' application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' /templates/{id}/versions/{version_id}/: get: operationId: templates_versions_retrieve_2 description: Retrieve a single version, including its full snapshot, or delete it parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true - in: path name: version_id schema: type: string required: true tags: - templates security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' delete: operationId: templates_versions_destroy description: Retrieve a single version, including its full snapshot, or delete it parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true - in: path name: version_id schema: type: string required: true tags: - templates security: - knoxApiToken: [] responses: '204': description: No response body /templates/{id}/versions/{version_id}/rollback/: post: operationId: templates_versions_rollback_create description: Restore the template to the state captured in a previous version. parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this template. required: true - in: path name: version_id schema: type: string required: true tags: - templates requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' multipart/form-data: schema: $ref: '#/components/schemas/Template' application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' application/xml: schema: $ref: '#/components/schemas/Template' description: '' /users/: get: operationId: users_list description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: date_joined schema: type: string format: date-time - in: query name: email schema: type: string - in: query name: first_name schema: type: string - in: query name: format schema: type: string enum: - json - xml - in: query name: groups schema: type: array items: type: integer explode: true style: form - in: query name: is_active schema: type: boolean - in: query name: is_staff schema: type: boolean - in: query name: is_superuser schema: type: boolean - in: query name: last_login schema: type: string format: date-time - in: query name: last_name schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: password schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: user_permissions schema: type: array items: type: integer explode: true style: form - in: query name: username schema: type: string tags: - users security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' application/xml: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' post: operationId: users_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - users requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User' multipart/form-data: schema: $ref: '#/components/schemas/User' application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' description: '' /users/{id}/: get: operationId: users_retrieve description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - users security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' description: '' put: operationId: users_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - users requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User' multipart/form-data: schema: $ref: '#/components/schemas/User' application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' description: '' patch: operationId: users_partial_update description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - users requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUser' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUser' application/json: schema: $ref: '#/components/schemas/PatchedUser' application/xml: schema: $ref: '#/components/schemas/PatchedUser' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' description: '' delete: operationId: users_destroy description: |- This class will define the view behavior Args: viewsets ([OCSVIewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - users security: - knoxApiToken: [] responses: '204': description: No response body /users/{id}/group-assignments/: post: operationId: users_group_assignments_create description: Create or update one user group assignment and resync effective groups parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - users requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User' multipart/form-data: schema: $ref: '#/components/schemas/User' application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' application/xml: schema: $ref: '#/components/schemas/User' description: '' /users/{id}/group-assignments/{assignment_id}/: delete: operationId: users_group_assignments_destroy description: Delete one user group assignment and resync effective groups parameters: - in: path name: assignment_id schema: type: string required: true - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - users security: - knoxApiToken: [] responses: '204': description: No response body /virtual_cols/: get: operationId: virtual_cols_list description: |- This class will define the view behavior Args: viewsets ([RestrictVisibilityViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: query name: id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: target schema: type: string enum: - asset description: '* `asset` - Assets' tags: - virtual_cols security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualColList' application/xml: schema: $ref: '#/components/schemas/PaginatedVirtualColList' description: '' post: operationId: virtual_cols_create description: |- Handle post request, suitable for single and multi creation Args: request ([dict]): can be dict or list of dicts Returns: [type]: [description] parameters: - in: query name: format schema: type: string enum: - json - xml tags: - virtual_cols requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VirtualCol' multipart/form-data: schema: $ref: '#/components/schemas/VirtualCol' application/json: schema: $ref: '#/components/schemas/VirtualCol' application/xml: schema: $ref: '#/components/schemas/VirtualCol' required: true security: - knoxApiToken: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualCol' application/xml: schema: $ref: '#/components/schemas/VirtualCol' description: '' /virtual_cols/{id}/: get: operationId: virtual_cols_retrieve description: |- This class will define the view behavior Args: viewsets ([RestrictVisibilityViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this virtual col. required: true tags: - virtual_cols security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCol' application/xml: schema: $ref: '#/components/schemas/VirtualCol' description: '' put: operationId: virtual_cols_update description: |- User needs to either be the creator or part of the group (if allow_group_modification is enabled) to modify a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this virtual col. required: true tags: - virtual_cols requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/VirtualCol' multipart/form-data: schema: $ref: '#/components/schemas/VirtualCol' application/json: schema: $ref: '#/components/schemas/VirtualCol' application/xml: schema: $ref: '#/components/schemas/VirtualCol' required: true security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCol' application/xml: schema: $ref: '#/components/schemas/VirtualCol' description: '' patch: operationId: virtual_cols_partial_update description: |- This class will define the view behavior Args: viewsets ([RestrictVisibilityViewSet]) parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this virtual col. required: true tags: - virtual_cols requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedVirtualCol' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVirtualCol' application/json: schema: $ref: '#/components/schemas/PatchedVirtualCol' application/xml: schema: $ref: '#/components/schemas/PatchedVirtualCol' security: - knoxApiToken: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCol' application/xml: schema: $ref: '#/components/schemas/VirtualCol' description: '' delete: operationId: virtual_cols_destroy description: User needs to be the creator to delete a visibility restricted object parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: integer description: A unique integer value identifying this virtual col. required: true tags: - virtual_cols security: - knoxApiToken: [] responses: '204': description: No response body components: schemas: AccountinfoConfig: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 512 datatype: $ref: '#/components/schemas/DatatypeEnum' datatarget: allOf: - $ref: '#/components/schemas/DatatargetEnum' default: ASSET accountinfo_values: type: array items: type: integer readOnly: true required: - accountinfo_values - description - id - name AccountinfoData: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true accountdata: nullable: true object_slug: type: string nullable: true maxLength: 100 content_type: type: integer readOnly: true object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 required: - content_type - id - object_id AccountinfoValue: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true accountinfo_config: type: integer value: type: string maxLength: 100 required: - accountinfo_config - id - value Action: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true rule: type: integer nullable: true priority: type: integer action: $ref: '#/components/schemas/ActionEnum' content_type: type: integer nullable: true object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true object_slug: type: string nullable: true maxLength: 100 field: type: string maxLength: 255 value: {} required: - action - field - id - value ActionEnum: enum: - set type: string description: '* `set` - Set' ApiCheckResponse: type: object properties: message: type: string required: - message AssetEOLStatus: type: object properties: id: type: integer readOnly: true asset: type: integer readOnly: true asset_name: type: string readOnly: true product: type: string readOnly: true nullable: true cycle: type: string readOnly: true nullable: true eol: type: string readOnly: true nullable: true is_eol: type: boolean readOnly: true support: type: boolean readOnly: true support_date: type: string readOnly: true nullable: true latest: type: string readOnly: true nullable: true fetched_at: type: string format: date-time readOnly: true required: - asset - asset_name - cycle - eol - fetched_at - id - is_eol - latest - product - support - support_date AssetGroup: type: object description: Serializer class for AssetGroup properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean name: type: string maxLength: 50 description: type: string nullable: true maxLength: 255 is_dynamic: type: boolean search: nullable: true last_updated: type: string format: date-time readOnly: true user: type: integer groups: type: array items: type: integer assets: type: array items: type: integer required: - id - last_updated - name - user AuthConfig: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 255 description: type: string nullable: true auth_method: type: integer nullable: true enabled: type: boolean priority: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true config: {} mappings: type: array items: type: integer required: - config - id - mappings AuthLevelEnum: enum: - noAuthNoPriv - authNoPriv - authPriv type: string description: |- * `noAuthNoPriv` - noAuthNoPriv * `authNoPriv` - authNoPriv * `authPriv` - authPriv AuthMapping: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true auth_config: type: integer nullable: true internal_field: type: string maxLength: 255 external_field: type: string maxLength: 255 required: - external_field - id - internal_field AuthMethod: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 255 auth_type: $ref: '#/components/schemas/AuthTypeEnum' enabled: type: boolean priority: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true configs: type: array items: type: integer required: - auth_type - configs - id - name AuthProtocolEnum: enum: - MD5 - SHA - None type: string description: |- * `MD5` - MD5 * `SHA` - SHA * `None` - None AuthToken: type: object properties: username: type: string writeOnly: true password: type: string writeOnly: true token: type: string readOnly: true required: - password - token - username AuthTypeEnum: enum: - SSO - OTHER type: string description: |- * `SSO` - SSO * `OTHER` - OTHER BlankEnum: enum: - '' Category: type: object description: |- This serialize class provide the API representation Args: serializers ([ModelSerializer]) properties: id: type: integer readOnly: true name: type: string maxLength: 50 description: type: string maxLength: 255 inventory_sections: type: array items: type: integer is_protected: type: boolean required: - description - id - name CollectionError: type: object properties: error: type: string required: - error CollectionResponse: type: object description: Response shape on successful asset creation/update properties: message: type: string id: type: integer required: - id - message ColumnLayout: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean name: type: string maxLength: 100 target: $ref: '#/components/schemas/TargetEnum' columns: {} last_updated: type: string format: date-time readOnly: true user: type: integer readOnly: true groups: type: array items: type: integer required: - columns - id - last_updated - name - user ComplianceResult: type: object description: |- Mixin to dynamically expand nested fields based on the "expand" query parameter. To use, add an `expandable_fields` dictionary in your serializer's Meta: expandable_fields = { "some_relation": SomeNestedSerializer, "other_relation": OtherNestedSerializer, } The mixin will: - Expand all fields and childs if expand="*" - Expand fields provided in a comma separated list (expand=field1,field2) - or return the pks for the relation properties: id: type: integer readOnly: true asset: type: integer asset_name: type: string readOnly: true rule: type: integer status: $ref: '#/components/schemas/ComplianceResultStatusEnum' detail: nullable: true evaluated_at: type: string format: date-time readOnly: true required: - asset - asset_name - evaluated_at - id - rule ComplianceResultStatusEnum: enum: - compliant - non_compliant - unknown type: string description: |- * `compliant` - Compliant * `non_compliant` - Non-compliant * `unknown` - Unknown ComplianceRule: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 type: type: string maxLength: 50 severity: $ref: '#/components/schemas/SeverityEnum' logic: {} enabled: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - created_at - id - logic - name - type - updated_at ComplianceType: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 50 required: - id - name Config: type: object description: This serialize class provide the API representation properties: name: type: string maxLength: 100 value: {} required: - name - value CustomEOLExtendedSupport: type: object properties: id: type: integer readOnly: true product: type: string description: endoflife.date product slug (e.g. ubuntu) maxLength: 100 cycle: type: string description: Version cycle (e.g. 22.04) maxLength: 50 is_extended: type: boolean description: Whether purchased extended support is active for this product/cycle required: - cycle - id - product DashboardChartCounter: type: object description: Response shape for the *Counter* charts (total_ALL, total_WIN, ...) properties: total: type: integer contacted: type: integer required: - contacted - total DashboardChartDescriptor: type: object description: Describes one chart available on the dashboard (returned by the list action) properties: category: type: string name: type: string description: type: string charttype: type: string required: - category - charttype - description - name DashboardChartSeries: type: object description: |- Response shape shared by the series-based charts (oscount, lastcontacted, networks) properties: options: {} series: {} required: - options - series DashboardChartTotal: type: object description: Response shape for the simple totals (nb_netdevices, nb_networks) properties: total: type: integer required: - total DashboardLayout: type: object description: This serialize class provide the API representation. properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' user: type: integer readOnly: true groups: type: array items: type: integer allow_group_modification: type: boolean name: type: string maxLength: 100 layout: {} required: - id - layout - name - user DatatargetEnum: enum: - ASSET - IPDISCOVER type: string description: |- * `ASSET` - Assets * `IPDISCOVER` - IPDiscover DatatypeEnum: enum: - TEXT - TEXTAREA - SELECT - CHECKBOX type: string description: |- * `TEXT` - Text * `TEXTAREA` - Textarea * `SELECT` - Select * `CHECKBOX` - Checkbox DebugCall: type: object properties: method: $ref: '#/components/schemas/MethodEnum' path: type: string maxLength: 2048 required: - method - path DebugResolve: type: object properties: calls: type: array items: $ref: '#/components/schemas/DebugCall' required: - calls Extension: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 version: type: string maxLength: 255 author: type: string nullable: true maxLength: 255 enabled: type: boolean django_app: type: string maxLength: 255 required: - django_app - id - name Field: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 50 order: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 retrieval_value: type: string nullable: true maxLength: 255 override_target: type: boolean nullable: true new_target: type: string nullable: true retrieval_method: nullable: true oneOf: - $ref: '#/components/schemas/FieldRetrievalMethodEnum' - $ref: '#/components/schemas/NullEnum' retrieval_output: nullable: true oneOf: - $ref: '#/components/schemas/RetrievalOutputEnum' - $ref: '#/components/schemas/NullEnum' section: type: integer options: nullable: true required: - id - name FieldRetrievalMethodEnum: enum: - FILE - BASH - PW - CMD type: string description: |- * `FILE` - Read file * `BASH` - Bash command * `PW` - Powershell command * `CMD` - Cmd command FileManager: type: object description: Serializer for the FileManager model. properties: id: type: integer readOnly: true created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true name: type: string maxLength: 255 file: type: string format: uri filesize: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 mimetype: type: string maxLength: 100 linked_model: type: string maxLength: 100 uuid: type: string format: uuid readOnly: true required: - created_at - file - filesize - id - linked_model - mimetype - modified_at - name - uuid Group: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 150 permissions: type: array items: type: integer is_protected: type: boolean writeOnly: true required: - id - name History: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true scheduler: type: integer date: type: string format: date-time readOnly: true status: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 comment: type: string maxLength: 255 required: - comment - date - id - scheduler - status InventoryBase: type: object description: Serializer class for Base properties: id: type: integer readOnly: true name: type: string maxLength: 50 description: type: string nullable: true maxLength: 255 serial: type: string maxLength: 255 osname: type: string maxLength: 255 osversion: type: string maxLength: 255 uuid: type: string maxLength: 255 srcip: type: string maxLength: 255 srcmac: type: string maxLength: 255 domain: type: string maxLength: 255 agent: type: string maxLength: 255 template: type: integer nullable: true last_update: type: string format: date-time readOnly: true is_template_forced: type: boolean matched: type: string readOnly: true required: - id - last_update - matched - name - osname - serial - uuid InventoryField: type: object description: Serializer class for InventoryField properties: id: type: integer readOnly: true inventory_section: type: integer template_field: type: integer value: type: string nullable: true required: - id - inventory_section - template_field InventorySection: type: object description: Serializer class for InventorySection properties: id: type: integer readOnly: true base: type: integer template_section: type: integer fields: type: array items: type: integer required: - base - fields - id - template_section LegacyError: type: object properties: error: type: string required: - error LegacyResponse: type: object description: Response shape on successful legacy asset creation/update properties: message: type: string id: type: integer required: - id - message LinkEnum: enum: - AND - OR type: string description: |- * `AND` - AND * `OR` - OR Log: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true asset: type: integer nullable: true timestamp: type: string format: date-time readOnly: true scope: $ref: '#/components/schemas/ScopeEnum' comment: type: string maxLength: 255 required: - comment - id - timestamp MethodEnum: enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD type: string description: |- * `GET` - GET * `POST` - POST * `PUT` - PUT * `PATCH` - PATCH * `DELETE` - DELETE * `OPTIONS` - OPTIONS * `HEAD` - HEAD MyAccount: type: object description: |- This serialize class provide the API representation Args: serializers ([ModelSerializer]) properties: id: type: integer readOnly: true username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: title: Email address oneOf: - type: string format: email maxLength: 254 - type: string maxLength: 0 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 password: type: string writeOnly: true maxLength: 128 is_superuser: type: boolean readOnly: true title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. groups: type: array items: type: integer readOnly: true description: The groups this user belongs to. A user will get all permissions granted to each of their groups. group_assignments: type: string readOnly: true user_permissions: type: array items: type: integer readOnly: true description: Specific permissions for this user. required: - group_assignments - groups - id - is_superuser - password - user_permissions - username Netdevice: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true ip: type: string netname: type: string maxLength: 128 mac: type: string maxLength: 20 network: type: integer last_seen: type: string format: date-time readOnly: true required: - id - ip - last_seen - mac - netname Netgroup: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 128 description: type: string maxLength: 1024 required: - description - id - name Network: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true nettag: type: string maxLength: 128 name: type: string maxLength: 128 description: type: string maxLength: 1024 netid: type: string mask: type: string netdevices: type: array items: $ref: '#/components/schemas/Netdevice' group: type: integer nullable: true last_update: type: string format: date-time readOnly: true required: - id - last_update - mask - netid Note: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true text: type: string creator: type: integer created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true object_slug: type: string nullable: true maxLength: 100 content_type: type: integer readOnly: true nullable: true object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true required: - content_type - created_at - creator - id - text - updated_at NullEnum: enum: - null OsEnum: enum: - LEG - DEB - RHEL - MAC - WIN - SNMP - VIRT type: string description: |- * `LEG` - Legacy * `DEB` - Linux (Debian based) * `RHEL` - Linux (RHEL based) * `MAC` - Mac * `WIN` - Windows * `SNMP` - SNMP * `VIRT` - Virtualization Package: type: object description: This serializer class provides the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 128 description: type: string date_created: type: string format: date-time readOnly: true target_os: $ref: '#/components/schemas/TargetOsEnum' actions_list: type: array items: $ref: '#/components/schemas/Action' result: type: array items: $ref: '#/components/schemas/Result' required: - actions_list - date_created - description - id - name - result PaginatedAccountinfoConfigList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AccountinfoConfig' PaginatedAccountinfoDataList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AccountinfoData' PaginatedAccountinfoValueList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AccountinfoValue' PaginatedActionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Action' PaginatedAssetEOLStatusList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AssetEOLStatus' PaginatedAssetGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AssetGroup' PaginatedAuthConfigList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AuthConfig' PaginatedAuthMappingList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AuthMapping' PaginatedAuthMethodList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AuthMethod' PaginatedCategoryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Category' PaginatedColumnLayoutList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ColumnLayout' PaginatedComplianceResultList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ComplianceResult' PaginatedComplianceRuleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ComplianceRule' PaginatedComplianceTypeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ComplianceType' PaginatedConfigList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Config' PaginatedCustomEOLExtendedSupportList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/CustomEOLExtendedSupport' PaginatedDashboardChartDescriptorList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DashboardChartDescriptor' PaginatedDashboardLayoutList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DashboardLayout' PaginatedExtensionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Extension' PaginatedFieldList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Field' PaginatedFileManagerList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/FileManager' PaginatedGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Group' PaginatedHistoryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/History' PaginatedInventoryBaseList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/InventoryBase' PaginatedInventoryFieldList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/InventoryField' PaginatedInventorySectionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/InventorySection' PaginatedLogList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Log' PaginatedMyAccountList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/MyAccount' PaginatedNetdeviceList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Netdevice' PaginatedNetgroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Netgroup' PaginatedNetworkList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Network' PaginatedNoteList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Note' PaginatedPackageList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Package' PaginatedPermissionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Permission' PaginatedResultList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Result' PaginatedRuleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Rule' PaginatedSchedulerList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Scheduler' PaginatedSearchList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Search' PaginatedSectionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Section' PaginatedServerInfoList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ServerInfo' PaginatedSnmpConfigList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/SnmpConfig' PaginatedSnmpScannerList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/SnmpScanner' PaginatedSoftwareDictionaryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/SoftwareDictionary' PaginatedSoftwareMappingList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/SoftwareMapping' PaginatedTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Template' PaginatedTriggerList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Trigger' PaginatedUserList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/User' PaginatedVirtualColList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VirtualCol' PaginatedWindowsBuildMappingList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/WindowsBuildMapping' PatchedAccountinfoConfig: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 512 datatype: $ref: '#/components/schemas/DatatypeEnum' datatarget: allOf: - $ref: '#/components/schemas/DatatargetEnum' default: ASSET accountinfo_values: type: array items: type: integer readOnly: true PatchedAccountinfoData: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true accountdata: nullable: true object_slug: type: string nullable: true maxLength: 100 content_type: type: integer readOnly: true object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 PatchedAccountinfoValue: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true accountinfo_config: type: integer value: type: string maxLength: 100 PatchedAction: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true rule: type: integer nullable: true priority: type: integer action: $ref: '#/components/schemas/ActionEnum' content_type: type: integer nullable: true object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true object_slug: type: string nullable: true maxLength: 100 field: type: string maxLength: 255 value: {} PatchedAssetGroup: type: object description: Serializer class for AssetGroup properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean name: type: string maxLength: 50 description: type: string nullable: true maxLength: 255 is_dynamic: type: boolean search: nullable: true last_updated: type: string format: date-time readOnly: true user: type: integer groups: type: array items: type: integer assets: type: array items: type: integer PatchedAuthConfig: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 255 description: type: string nullable: true auth_method: type: integer nullable: true enabled: type: boolean priority: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true config: {} mappings: type: array items: type: integer PatchedAuthMapping: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true auth_config: type: integer nullable: true internal_field: type: string maxLength: 255 external_field: type: string maxLength: 255 PatchedAuthMethod: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 255 auth_type: $ref: '#/components/schemas/AuthTypeEnum' enabled: type: boolean priority: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true configs: type: array items: type: integer PatchedCategory: type: object description: |- This serialize class provide the API representation Args: serializers ([ModelSerializer]) properties: id: type: integer readOnly: true name: type: string maxLength: 50 description: type: string maxLength: 255 inventory_sections: type: array items: type: integer is_protected: type: boolean PatchedColumnLayout: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean name: type: string maxLength: 100 target: $ref: '#/components/schemas/TargetEnum' columns: {} last_updated: type: string format: date-time readOnly: true user: type: integer readOnly: true groups: type: array items: type: integer PatchedComplianceResult: type: object description: |- Mixin to dynamically expand nested fields based on the "expand" query parameter. To use, add an `expandable_fields` dictionary in your serializer's Meta: expandable_fields = { "some_relation": SomeNestedSerializer, "other_relation": OtherNestedSerializer, } The mixin will: - Expand all fields and childs if expand="*" - Expand fields provided in a comma separated list (expand=field1,field2) - or return the pks for the relation properties: id: type: integer readOnly: true asset: type: integer asset_name: type: string readOnly: true rule: type: integer status: $ref: '#/components/schemas/ComplianceResultStatusEnum' detail: nullable: true evaluated_at: type: string format: date-time readOnly: true PatchedComplianceRule: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 type: type: string maxLength: 50 severity: $ref: '#/components/schemas/SeverityEnum' logic: {} enabled: type: boolean created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true PatchedComplianceType: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 50 PatchedConfig: type: object description: This serialize class provide the API representation properties: name: type: string maxLength: 100 value: {} PatchedCustomEOLExtendedSupport: type: object properties: id: type: integer readOnly: true product: type: string description: endoflife.date product slug (e.g. ubuntu) maxLength: 100 cycle: type: string description: Version cycle (e.g. 22.04) maxLength: 50 is_extended: type: boolean description: Whether purchased extended support is active for this product/cycle PatchedDashboardChartDescriptor: type: object description: Describes one chart available on the dashboard (returned by the list action) properties: category: type: string name: type: string description: type: string charttype: type: string PatchedDashboardLayout: type: object description: This serialize class provide the API representation. properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' user: type: integer readOnly: true groups: type: array items: type: integer allow_group_modification: type: boolean name: type: string maxLength: 100 layout: {} PatchedExtension: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 version: type: string maxLength: 255 author: type: string nullable: true maxLength: 255 enabled: type: boolean django_app: type: string maxLength: 255 PatchedField: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 50 order: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 retrieval_value: type: string nullable: true maxLength: 255 override_target: type: boolean nullable: true new_target: type: string nullable: true retrieval_method: nullable: true oneOf: - $ref: '#/components/schemas/FieldRetrievalMethodEnum' - $ref: '#/components/schemas/NullEnum' retrieval_output: nullable: true oneOf: - $ref: '#/components/schemas/RetrievalOutputEnum' - $ref: '#/components/schemas/NullEnum' section: type: integer options: nullable: true PatchedFileManager: type: object description: Serializer for the FileManager model. properties: id: type: integer readOnly: true created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true name: type: string maxLength: 255 file: type: string format: uri filesize: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 mimetype: type: string maxLength: 100 linked_model: type: string maxLength: 100 uuid: type: string format: uuid readOnly: true PatchedGroup: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 150 permissions: type: array items: type: integer is_protected: type: boolean writeOnly: true PatchedHistory: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true scheduler: type: integer date: type: string format: date-time readOnly: true status: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 comment: type: string maxLength: 255 PatchedInventoryBase: type: object description: Serializer class for Base properties: id: type: integer readOnly: true name: type: string maxLength: 50 description: type: string nullable: true maxLength: 255 serial: type: string maxLength: 255 osname: type: string maxLength: 255 osversion: type: string maxLength: 255 uuid: type: string maxLength: 255 srcip: type: string maxLength: 255 srcmac: type: string maxLength: 255 domain: type: string maxLength: 255 agent: type: string maxLength: 255 template: type: integer nullable: true last_update: type: string format: date-time readOnly: true is_template_forced: type: boolean matched: type: string readOnly: true PatchedInventoryField: type: object description: Serializer class for InventoryField properties: id: type: integer readOnly: true inventory_section: type: integer template_field: type: integer value: type: string nullable: true PatchedInventorySection: type: object description: Serializer class for InventorySection properties: id: type: integer readOnly: true base: type: integer template_section: type: integer fields: type: array items: type: integer PatchedLog: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true asset: type: integer nullable: true timestamp: type: string format: date-time readOnly: true scope: $ref: '#/components/schemas/ScopeEnum' comment: type: string maxLength: 255 PatchedMyAccount: type: object description: |- This serialize class provide the API representation Args: serializers ([ModelSerializer]) properties: id: type: integer readOnly: true username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: title: Email address oneOf: - type: string format: email maxLength: 254 - type: string maxLength: 0 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 password: type: string writeOnly: true maxLength: 128 is_superuser: type: boolean readOnly: true title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. groups: type: array items: type: integer readOnly: true description: The groups this user belongs to. A user will get all permissions granted to each of their groups. group_assignments: type: string readOnly: true user_permissions: type: array items: type: integer readOnly: true description: Specific permissions for this user. PatchedNetdevice: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true ip: type: string netname: type: string maxLength: 128 mac: type: string maxLength: 20 network: type: integer last_seen: type: string format: date-time readOnly: true PatchedNetgroup: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 128 description: type: string maxLength: 1024 PatchedNetwork: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true nettag: type: string maxLength: 128 name: type: string maxLength: 128 description: type: string maxLength: 1024 netid: type: string mask: type: string netdevices: type: array items: $ref: '#/components/schemas/Netdevice' group: type: integer nullable: true last_update: type: string format: date-time readOnly: true PatchedNote: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true text: type: string creator: type: integer created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true object_slug: type: string nullable: true maxLength: 100 content_type: type: integer readOnly: true nullable: true object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true PatchedPackage: type: object description: This serializer class provides the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 128 description: type: string date_created: type: string format: date-time readOnly: true target_os: $ref: '#/components/schemas/TargetOsEnum' actions_list: type: array items: $ref: '#/components/schemas/Action' result: type: array items: $ref: '#/components/schemas/Result' PatchedResult: type: object description: This serializer class provides the API representation properties: id: type: integer readOnly: true package: type: integer nullable: true asset: type: integer nullable: true group: type: integer nullable: true name: type: string maxLength: 128 status: allOf: - $ref: '#/components/schemas/ResultStatusEnum' minimum: -9223372036854775808 maximum: 9223372036854775807 comment: type: string nullable: true date_created: type: string format: date-time readOnly: true PatchedRule: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true priority: type: integer description: type: string nullable: true maxLength: 255 trigger: $ref: '#/components/schemas/TriggerEnum' enabled: type: boolean logic: {} break_on_match: type: boolean actions: type: array items: type: integer PatchedScheduler: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 1024 active: type: boolean recurrence: $ref: '#/components/schemas/RecurrenceEnum' last_execution: type: string format: date-time nullable: true hour: type: string format: time nullable: true day_of_week: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true day_of_month: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true is_protected: type: boolean PatchedSearch: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean search: {} last_updated: type: string format: date-time readOnly: true name: type: string maxLength: 50 description: type: string nullable: true user: type: integer groups: type: array items: type: integer PatchedSection: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 50 retrieval_method: $ref: '#/components/schemas/SectionRetrievalMethodEnum' retrieval_output: $ref: '#/components/schemas/RetrievalOutputEnum' target: type: string template: type: integer fields: type: array items: $ref: '#/components/schemas/Field' options: nullable: true is_active: type: boolean PatchedSnmpConfig: type: object description: This serializer class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 128 version: $ref: '#/components/schemas/VersionEnum' user: type: string nullable: true maxLength: 128 auth_level: nullable: true oneOf: - $ref: '#/components/schemas/AuthLevelEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' password: type: string nullable: true maxLength: 128 auth_protocol: nullable: true oneOf: - $ref: '#/components/schemas/AuthProtocolEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' priv_protocol: nullable: true oneOf: - $ref: '#/components/schemas/PrivProtocolEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' priv_password: type: string nullable: true maxLength: 128 retries: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 subnets: {} PatchedSnmpScanner: type: object description: This serializer class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 100 ip: type: string subnets: {} notes: type: string nullable: true last_updated: type: string format: date-time readOnly: true total_scanned: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true total_found: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true last_scan_date: type: string format: date-time nullable: true configs: type: array items: type: integer assets: type: array items: type: integer PatchedSoftwareDictionary: type: object description: Serialize aggregated asset/software relationships properties: id: type: integer readOnly: true name: type: string nullable: true publisher: type: string nullable: true version: type: string nullable: true maxLength: 128 major_version: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true minor_version: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true patch_version: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true assets: type: array items: type: integer readOnly: true updated_at: type: string format: date-time readOnly: true installation_number: type: integer readOnly: true PatchedSoftwareMapping: type: object description: |- Mixin to dynamically expand nested fields based on the "expand" query parameter. To use, add an `expandable_fields` dictionary in your serializer's Meta: expandable_fields = { "some_relation": SomeNestedSerializer, "other_relation": OtherNestedSerializer, } The mixin will: - Expand all fields and childs if expand="*" - Expand fields provided in a comma separated list (expand=field1,field2) - or return the pks for the relation properties: id: type: integer readOnly: true template: type: integer section: type: integer name: type: integer nullable: true publisher: type: integer nullable: true version: type: integer nullable: true major_version: type: integer nullable: true minor_version: type: integer nullable: true patch_version: type: integer nullable: true PatchedTemplate: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 50 os: $ref: '#/components/schemas/OsEnum' is_protected: type: boolean last_update: type: string format: date-time readOnly: true sections: type: array items: $ref: '#/components/schemas/Section' PatchedTrigger: type: object properties: trigger: type: string model_name: type: string action_targets: type: object additionalProperties: type: array items: type: string context_fields: type: string readOnly: true PatchedUser: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: title: Email address oneOf: - type: string format: email maxLength: 254 - type: string maxLength: 0 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 password: type: string writeOnly: true maxLength: 128 is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. groups: type: array items: type: integer description: The groups this user belongs to. A user will get all permissions granted to each of their groups. group_assignments: type: string readOnly: true user_permissions: type: array items: type: integer description: Specific permissions for this user. PatchedVirtualCol: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean name: type: string maxLength: 100 target: $ref: '#/components/schemas/TargetEnum' mapping: {} last_updated: type: string format: date-time readOnly: true user: type: integer readOnly: true groups: type: array items: type: integer PatchedWindowsBuildMapping: type: object properties: id: type: integer readOnly: true build: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 description: Windows build number (e.g. 22621) channel: type: string description: endoflife.date channel slug (e.g. 22h2) maxLength: 20 Permission: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 255 content_type: type: integer codename: type: string maxLength: 100 required: - codename - content_type - id - name PrivProtocolEnum: enum: - DES - AES - None type: string description: |- * `DES` - DES * `AES` - AES * `None` - None ReconciliationError: type: object properties: error: type: string required: - error ReconciliationResponse: type: object description: 'id: the matched asset''s id, or False if no asset matched' properties: id: {} required: - id RecurrenceEnum: enum: - hourly - daily - weekly - monthly type: string description: |- * `hourly` - hourly * `daily` - daily * `weekly` - weekly * `monthly` - monthly Result: type: object description: This serializer class provides the API representation properties: id: type: integer readOnly: true package: type: integer nullable: true asset: type: integer nullable: true group: type: integer nullable: true name: type: string maxLength: 128 status: allOf: - $ref: '#/components/schemas/ResultStatusEnum' minimum: -9223372036854775808 maximum: 9223372036854775807 comment: type: string nullable: true date_created: type: string format: date-time readOnly: true required: - asset - date_created - group - id - name ResultStatusEnum: enum: - 0 - 1 - 2 - 3 type: integer description: |- * `0` - Sucess * `1` - Waiting notification * `2` - Notified * `3` - Error RetrievalOutputEnum: enum: - PTXT - JSON - TBLE - REGX - GREP type: string description: |- * `PTXT` - Plain text * `JSON` - JSON format * `TBLE` - Table format * `REGX` - Regex processing * `GREP` - Grep command output Rule: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true priority: type: integer description: type: string nullable: true maxLength: 255 trigger: $ref: '#/components/schemas/TriggerEnum' enabled: type: boolean logic: {} break_on_match: type: boolean actions: type: array items: type: integer required: - actions - id - logic - trigger Scheduler: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 1024 active: type: boolean recurrence: $ref: '#/components/schemas/RecurrenceEnum' last_execution: type: string format: date-time nullable: true hour: type: string format: time nullable: true day_of_week: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true day_of_month: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true is_protected: type: boolean required: - active - description - id - name ScopeEnum: enum: - INVENTORY_BASE_INSERT - INVENTORY_BASE_UPDATE - INVENTORY_EXT_INSERT - INVENTORY_EXT_UPDATE - INVENTORY_BASE_ERR - INVENTORY_EXT_ERR - DEPLOYMENT_ACK - DEPLOYMENT_ERR - CONFIG_UPDATE - CONFIG_ERR - TEMPLATE_UPDATE - TEMPLATE_ERR - UNKNOWN type: string description: |- * `INVENTORY_BASE_INSERT` - Inserting new items into the base inventory * `INVENTORY_BASE_UPDATE` - Updating existing items in the base inventory * `INVENTORY_EXT_INSERT` - Inserting new items into the extended inventory * `INVENTORY_EXT_UPDATE` - Updating existing items in the extended inventory * `INVENTORY_BASE_ERR` - Error related to the base inventory operations * `INVENTORY_EXT_ERR` - Error related to the extended inventory operations * `DEPLOYMENT_ACK` - Acknowledgment of a successful deployment * `DEPLOYMENT_ERR` - Error during the deployment process * `CONFIG_UPDATE` - Updating configuration settings * `CONFIG_ERR` - Error related to configuration operations * `TEMPLATE_UPDATE` - Updating templates for a process * `TEMPLATE_ERR` - Error related to template operations * `UNKNOWN` - Unknown error happend (default) Search: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean search: {} last_updated: type: string format: date-time readOnly: true name: type: string maxLength: 50 description: type: string nullable: true user: type: integer groups: type: array items: type: integer required: - id - last_updated - name - search - user SearchCondition: type: object description: |- One search condition, as sent in a search_data AND-group. Example: {"object": "software_dictionary_entries", "route": "software_dictionary", "field": "name", "fieldtype": "string", "operator": "iexact", "value": "Git", "link": "AND"} properties: object: type: string description: Target model key, e.g. 'InventoryBase', 'AccountinfoConfig', 'results', 'logs', 'snmpscanner', 'inventory_sections', 'software_dictionary_entries'. route: type: string description: Frontend route associated with the condition. field: type: string description: Field name to filter on. fieldtype: type: string description: Field type hint, e.g. 'string', 'select', 'checkbox'. operator: type: string description: Lookup operator, e.g. 'exact', 'iexact', 'icontains', 'istartswith', 'iendswith'. value: description: Value to compare the field against. link: allOf: - $ref: '#/components/schemas/LinkEnum' default: AND description: |- How this condition links to the previous one. * `AND` - AND * `OR` - OR section: type: string description: Template section id, required when object is 'inventory_sections'. required: - field - object - operator - value SearchError: type: object properties: error: type: string required: - error SearchRequest: type: object description: |- Payload accepted by POST /search/. search_data is a list of AND-groups; groups are combined using each group's first condition 'link' (AND/OR). properties: search_data: type: array items: type: array items: $ref: '#/components/schemas/SearchCondition' description: List of AND-condition groups to combine into the search query. grouped: type: boolean default: true description: If true, results are grouped by asset with a single matched row per relation. ungroup: type: boolean default: false description: If true, one row is returned per matched related record instead of one per asset. Section: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 50 retrieval_method: $ref: '#/components/schemas/SectionRetrievalMethodEnum' retrieval_output: $ref: '#/components/schemas/RetrievalOutputEnum' target: type: string template: type: integer fields: type: array items: $ref: '#/components/schemas/Field' options: nullable: true is_active: type: boolean required: - fields - id - name - target SectionRetrievalMethodEnum: enum: - FILE - BASH - PW - CMD - SNMP_WALK - SNMP_GET type: string description: |- * `FILE` - Read file * `BASH` - Bash command * `PW` - Powershell command * `CMD` - Cmd command * `SNMP_WALK` - Walk the SNMP tree starting from a specific OID * `SNMP_GET` - Get a specific OID ServerInfo: type: object properties: backend_version: type: string nullable: true authentication_type: type: array items: type: string infrastructure_type: type: string nullable: true operating_system: type: string nullable: true operating_system_version: type: string nullable: true db_engine: type: string nullable: true ocs_configuration: {} python_version: type: string nullable: true python_libs_version: type: object additionalProperties: type: string nullable: true required: - authentication_type - backend_version - db_engine - infrastructure_type - ocs_configuration - operating_system - operating_system_version - python_libs_version - python_version SeverityEnum: enum: - critical - high - medium - low type: string description: |- * `critical` - Critical * `high` - High * `medium` - Medium * `low` - Low SnmpConfig: type: object description: This serializer class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 128 version: $ref: '#/components/schemas/VersionEnum' user: type: string nullable: true maxLength: 128 auth_level: nullable: true oneOf: - $ref: '#/components/schemas/AuthLevelEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' password: type: string nullable: true maxLength: 128 auth_protocol: nullable: true oneOf: - $ref: '#/components/schemas/AuthProtocolEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' priv_protocol: nullable: true oneOf: - $ref: '#/components/schemas/PrivProtocolEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' priv_password: type: string nullable: true maxLength: 128 retries: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 subnets: {} required: - id - name - subnets - version SnmpScanner: type: object description: This serializer class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 100 ip: type: string subnets: {} notes: type: string nullable: true last_updated: type: string format: date-time readOnly: true total_scanned: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true total_found: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true last_scan_date: type: string format: date-time nullable: true configs: type: array items: type: integer assets: type: array items: type: integer required: - id - ip - last_updated - name SoftwareDictionary: type: object description: Serialize aggregated asset/software relationships properties: id: type: integer readOnly: true name: type: string nullable: true publisher: type: string nullable: true version: type: string nullable: true maxLength: 128 major_version: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true minor_version: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true patch_version: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true assets: type: array items: type: integer readOnly: true updated_at: type: string format: date-time readOnly: true installation_number: type: integer readOnly: true required: - assets - id - installation_number - updated_at SoftwareMapping: type: object description: |- Mixin to dynamically expand nested fields based on the "expand" query parameter. To use, add an `expandable_fields` dictionary in your serializer's Meta: expandable_fields = { "some_relation": SomeNestedSerializer, "other_relation": OtherNestedSerializer, } The mixin will: - Expand all fields and childs if expand="*" - Expand fields provided in a comma separated list (expand=field1,field2) - or return the pks for the relation properties: id: type: integer readOnly: true template: type: integer section: type: integer name: type: integer nullable: true publisher: type: integer nullable: true version: type: integer nullable: true major_version: type: integer nullable: true minor_version: type: integer nullable: true patch_version: type: integer nullable: true required: - id - section - template TargetEnum: enum: - asset type: string description: '* `asset` - Assets' TargetOsEnum: enum: - WIN - LIN - MAC type: string description: |- * `WIN` - Windows * `LIN` - Linux * `MAC` - Mac Template: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true name: type: string maxLength: 50 os: $ref: '#/components/schemas/OsEnum' is_protected: type: boolean last_update: type: string format: date-time readOnly: true sections: type: array items: $ref: '#/components/schemas/Section' required: - id - last_update - name - sections Trigger: type: object properties: trigger: type: string model_name: type: string action_targets: type: object additionalProperties: type: array items: type: string context_fields: type: string readOnly: true required: - action_targets - context_fields - model_name - trigger TriggerEnum: enum: - inventory_received - user_login - netdevice_received type: string description: |- * `inventory_received` - Inventory Received * `user_login` - User Login * `netdevice_received` - Netdevice Received User: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: title: Email address oneOf: - type: string format: email maxLength: 254 - type: string maxLength: 0 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 password: type: string writeOnly: true maxLength: 128 is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. groups: type: array items: type: integer description: The groups this user belongs to. A user will get all permissions granted to each of their groups. group_assignments: type: string readOnly: true user_permissions: type: array items: type: integer description: Specific permissions for this user. required: - group_assignments - id - password - username VersionEnum: enum: - '1' - 2c - '3' type: string description: |- * `1` - SNMPv1 * `2c` - SNMPv2c * `3` - SNMPv3 VirtualCol: type: object description: This serialize class provide the API representation properties: id: type: integer readOnly: true visibility: $ref: '#/components/schemas/VisibilityEnum' allow_group_modification: type: boolean name: type: string maxLength: 100 target: $ref: '#/components/schemas/TargetEnum' mapping: {} last_updated: type: string format: date-time readOnly: true user: type: integer readOnly: true groups: type: array items: type: integer required: - id - last_updated - name - user VisibilityEnum: enum: - public - private_personal - private_group type: string description: |- * `public` - Public * `private_personal` - Private (Personal) * `private_group` - Private (Group) WindowsBuildMapping: type: object properties: id: type: integer readOnly: true build: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 description: Windows build number (e.g. 22621) channel: type: string description: endoflife.date channel slug (e.g. 22h2) maxLength: 20 required: - build - channel - id securitySchemes: knoxApiToken: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Token"