### Example HATEOAS Link Object Structure Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md Illustrates the structure of the 'links' property returned in API resources, adhering to HATEOAS, JSON:API, and JSON Hyper-Schema formats. It shows the basic 'rel' and 'href' properties. ```JSON "links": [{ "rel": "", "href": "" ... }] ``` -------------------------------- ### GET /api/3/sites/{id}/alerts/snmp - Retrieve Site SNMP Alerts Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-2.md Retrieves all SNMP alerts defined for a specific site using its identifier. ```API Documentation Parameters: - Name: id, Located in: path, Description: The identifier of the site., Required: Yes, Schema: integer Responses: - Code: 200, Description: OK, Schema: [Resources%C2%ABSnmpAlert%C2%BB](#resources%c2%absnmpalert%c2%bb) - Code: 401, Description: Unauthorized, Schema: [UnauthorizedError](#unauthorizederror) - Code: 404, Description: Not Found, Schema: [NotFoundError](#notfounderror) - Code: 500, Description: Internal Server Error, Schema: [InternalServerError](#internalservererror) - Code: 503, Description: Service Unavailable, Schema: [ServiceUnavailableError](#serviceunavailableerror) ``` -------------------------------- ### GET /api/3/sites/{id}/alerts/snmp/{alertId} - Retrieve Specific Site SNMP Alert Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-2.md Retrieves a specific SNMP alert for a site using the site and alert identifiers. ```API Documentation Parameters: - Name: id, Located in: path, Description: The identifier of the site., Required: Yes, Schema: integer - Name: alertId, Located in: path, Description: The identifier of the alert., Required: Yes, Schema: integer Responses: - Code: 200, Description: OK, Schema: [SnmpAlert](#snmpalert) - Code: 401, Description: Unauthorized, Schema: [UnauthorizedError](#unauthorizederror) - Code: 404, Description: Not Found, Schema: [NotFoundError](#notfounderror) - Code: 500, Description: Internal Server Error, Schema: [InternalServerError](#internalservererror) - Code: 503, Description: Service Unavailable, Schema: [ServiceUnavailableError](#serviceunavailableerror) ``` -------------------------------- ### Defining Instance Resource Path - InsightVM API - Path Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md This snippet shows the standard URL path convention for accessing specific instance resources in the InsightVM API v3. It includes the base path `/api/3/`, the resource name, and the instance identifier. ```Path /api/3/{resource_name}/{instance_id}... ``` -------------------------------- ### Specify Resource View Query Parameter (Bash) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md Demonstrates the URL format for requesting a specific view (`summary` or `details`) of a resource using the `view` query parameter. ```Bash /?view={viewName} ``` -------------------------------- ### POST /api/3/sites/{id}/alerts/snmp - Create Site SNMP Alert Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-2.md Creates a new SNMP alert for the specified site. The alert details are provided in the request body. ```API Documentation Parameters: - Name: alert, Located in: body, Description: Resource for creating a new SNMP alert., Required: No, Schema: [SnmpAlert](#snmpalert) - Name: id, Located in: path, Description: The identifier of the site., Required: Yes, Schema: integer Responses: - Code: 201, Description: Created, Schema: [ReferenceWith%C2%ABAlertID,Link%C2%BB](#referencewith%c2%abalertid,link%c2%bb) - Code: 400, Description: Bad Request, Schema: [BadRequestError](#badrequesterror) - Code: 401, Description: Unauthorized, Schema: [UnauthorizedError](#unauthorizederror) - Code: 500, Description: Internal Server Error, Schema: [InternalServerError](#internalservererror) - Code: 503, Description: Service Unavailable, Schema: [ServiceUnavailableError](#serviceunavailableerror) ``` -------------------------------- ### Configuration Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Represents a configuration value with a required name and an optional value, both as strings. ```JSON { "name": "string", "value": "string" } ``` -------------------------------- ### OperatingSystem Structure Definition Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Defines the structure representing an operating system resource, including its architecture, configurations, CPE details, description, family, ID, product name, system name, type, vendor, and version. ```markdown | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | architecture | string | The architecture of the operating system.
*Example:* `"x86"` | No | | configurations | [ [Configuration](#configuration) ] | Configuration key-values pairs enumerated on the operating system. | No | | cpe | [OperatingSystemCpe](#operatingsystemcpe) | The Common Platform Enumeration (CPE) of the operating system.
*Example:* `""` | No | | description | string | The description of the operating system (containing vendor, family, product, version and architecture in a single string).
*Example:* `"Microsoft Windows Server 2008 Enterprise Edition SP1"` | No | | family | string | The family of the operating system.
*Example:* `"Windows"` | No | | id | long | The identifier of the operating system.
*Example:* `35` | No | | product | string | The name of the operating system.
*Example:* `"Windows Server 2008 Enterprise Edition"` | No | | systemName | string | A combination of vendor and family (with redundancies removed), suitable for grouping.
*Example:* `"Microsoft Windows"` | No | | type | string | The type of operating system.
*Example:* `"Workstation"` | No | | vendor | string | The vendor of the operating system.
*Example:* `"Microsoft"` | No | | version | string | The version of the operating system.
*Example:* `"SP1"` | No | ``` -------------------------------- ### ConsoleCommandOutput Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Details the output from a console command execution, including hypermedia links and the command's output as a string. ```JSON { "links": [ "Link" ], "output": "string" } ``` -------------------------------- ### Paginated API Response Format (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md Explains the structure of a paginated response, detailing the `resources` array containing the items, the `page` object with pagination metadata (number, size, totalResources, totalPages), and the `links` array for navigation (self, next, previous, first, last). ```JSON { "resources": [ ... ], "page": { "number" : ..., "size" : ..., "totalResources" : ..., "totalPages" : ... }, "links": [ "first" : { "href" : "..." }, "prev" : { "href" : "..." }, "self" : { "href" : "..." }, "next" : { "href" : "..." }, "last" : { "href" : "..." } ] } ``` -------------------------------- ### ContentDescription Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Provides different representations of content, including HTML and plain text formats. ```JSON { "html": "string", "text": "string" } ``` -------------------------------- ### OperatingSystemCpe Structure Definition Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Defines the structure for Common Platform Enumeration (CPE) details of an operating system, including various attributes like edition, language, part, product, vendor, and version, along with CPE 2.2 and 2.3 string formats. ```markdown | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | edition | string | Edition-related terms applied by the vendor to the product.
*Example:* `"enterprise"` | No | | language | string | Defines the language supported in the user interface of the product being described. The format is of the language tag adheres to RFC5646.
*Example:* `""` | No | | other | string | Captures any other general descriptive or identifying information which is vendor- or product-specific and which does not logically fit in any other attribute value.
*Example:* `""` | No | | part | string | A single letter code that designates the particular platform part that is being identified.
*Enum:* `"o"`, `"a"`, `"h"`
*Example:* `"o"` | Yes | | product | string | the most common and recognizable title or name of the product.
*Example:* `"windows_server_2008"` | No | | swEdition | string | Characterizes how the product is tailored to a particular market or class of end users.
*Example:* `""` | No | | targetHW | string | Characterize the instruction set architecture on which the product operates.
*Example:* `""` | No | | targetSW | string | Characterize the software computing environment within which the product operates.
*Example:* `""` | No | | update | string | Vendor-specific alphanumeric strings characterizing the particular update, service pack, or point release of the product.
*Example:* `"sp1"` | No | | v2.2 | string | The full CPE string in the CPE 2.2 format.
*Example:* `"cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise"` | No | | v2.3 | string | The full CPE string in the CPE 2.3 format.
*Example:* `"cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*"` | No | | vendor | string | The person or organization that manufactured or created the product.
*Example:* `"microsoft"` | No | | version | string | Vendor-specific alphanumeric strings characterizing the particular release version of the product.
*Example:* `"-"` | No | ``` -------------------------------- ### CreatedReference Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md A generic reference object indicating a resource that was created, including its identifier and associated hypermedia links. ```JSON { "id": "object", "links": [ "Link" ] } ``` -------------------------------- ### CPUInfo Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Provides information about the system's CPU, including the clock speed in MHz and the total count of CPUs. ```JSON { "clockSpeed": "integer", "count": "integer" } ``` -------------------------------- ### CreateAuthenticationSource Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Specifies the authentication source to use for user authentication, requiring a type and optionally an identifier. ```JSON { "id": "integer", "type": "string" } ``` -------------------------------- ### Defining Collection Resource Path - InsightVM API - Path Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md This snippet shows the standard URL path convention for accessing collection resources in the InsightVM API v3. It includes the base path `/api/3/` followed by the pluralized resource name. ```Path /api/3/{resource_name} ``` -------------------------------- ### NotFoundError Structure Definition Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Defines the structure of an error response when a requested resource is not found. Includes hypermedia links, a descriptive message, and the HTTP status code. ```markdown | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | links | [ [Link](#link) ] | Hypermedia links to corresponding or related resources. | No | | message | string | The messages indicating the cause or reason for failure.
*Example:* `"An error has occurred."` | No | | status | string | The HTTP status code for the error (same as in the HTTP response).
*Enum:* `"404"`
*Example:* `"404"` | Yes | ``` -------------------------------- ### API Error Response Format (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md Details the structure of error responses for 4xx and 5xx HTTP statuses, including the `status` code, a localized `message` explaining the error, and optional `links` for troubleshooting. ```JSON { "status": , "message": , "links" : [ { "rel" : "...", "href" : "..." } ] } ``` -------------------------------- ### CreatedOrUpdatedReference Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md A generic reference object indicating a resource that was created or updated, including its identifier and associated hypermedia links. ```JSON { "id": "object", "links": [ "Link" ] } ``` -------------------------------- ### CreatedReference«CredentialID,Link» Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md A specific reference object for a created Credential resource, including its integer identifier and associated hypermedia links. ```JSON { "id": "integer", "links": [ "Link" ] } ``` -------------------------------- ### CreatedReference«EngineID,Link» Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md A specific reference object for a created Engine resource, including its integer identifier and associated hypermedia links. ```JSON { "id": "integer", "links": [ "Link" ] } ``` -------------------------------- ### BackupsSize Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Represents the size of backups, providing both the raw byte count as a long integer and a human-readable formatted string. ```JSON { "bytes": "long", "formatted": "string" } ``` -------------------------------- ### PUT /api/3/sites/{id}/alerts/snmp - Update All Site SNMP Alerts Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-2.md Updates all SNMP alerts for the specified site using an array of resources in the request body. Alerts omitted from the request will be deleted. ```API Documentation Parameters: - Name: alert, Located in: body, Description: Array of resources for updating all SNMP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site., Required: No, Schema: [ [SnmpAlert](#snmpalert) ] - Name: id, Located in: path, Description: The identifier of the site., Required: Yes, Schema: integer Responses: - Code: 200, Description: OK, Schema: [Links](#links) - Code: 400, Description: Bad Request, Schema: [BadRequestError](#badrequesterror) - Code: 401, Description: Unauthorized, Schema: [UnauthorizedError](#unauthorizederror) - Code: 404, Description: Not Found, Schema: [NotFoundError](#notfounderror) - Code: 500, Description: Internal Server Error, Schema: [InternalServerError](#internalservererror) - Code: 503, Description: Service Unavailable, Schema: [ServiceUnavailableError](#serviceunavailableerror) ``` -------------------------------- ### AvailableReportFormat Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Defines the structure for available report formats, including the format type and associated templates. The format property is a string with specific enum values, and templates is an array of strings. ```JSON { "format": "string", "templates": [ "string" ] } ``` -------------------------------- ### CreatedReference«DiscoveryQueryID,Link» Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md A specific reference object for a created Discovery Query resource, including its long integer identifier and associated hypermedia links. ```JSON { "id": "long", "links": [ "Link" ] } ``` -------------------------------- ### BadRequestError Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md Describes the structure of an error response for a bad request, including hypermedia links, a descriptive message, and the HTTP status code. ```JSON { "links": [ "Link" ], "message": "string", "status": "string" } ``` -------------------------------- ### CreatedReference«AssetGroupID,Link» Object Definition (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-5.md A specific reference object for a created Asset Group resource, including its integer identifier and associated hypermedia links. ```JSON { "id": "integer", "links": [ "Link" ] } ``` -------------------------------- ### Search Criteria Filter Format (JSON) Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md Explains the generic JSON format for a single search filter used within a search criteria array to match assets. It includes required `field` and `operator` properties and optional value properties (`value`, `lower`, `upper`) depending on the operator and data type. ```JSON { "field": "", "operator": "", ["value": ,] ["lower": ,] ["upper": ] } ``` -------------------------------- ### Define Discovery Connection Search Filter JSON Structure Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-1.md This JSON structure represents a single search filter used within an array of search criteria for dynamic site discovery connections. It requires 'field' and 'operator' properties and may include 'value', 'lower', or 'upper' depending on the specified operator. ```json { "field": "", "operator": "", ["value": "",] ["lower": "",] ["upper": ""] } ``` -------------------------------- ### DELETE /api/3/sites/{id}/alerts/snmp - Delete All Site SNMP Alerts Source: https://github.com/elzozz/r7-vm-api-v3/blob/main/r7-api-v3-logical-part-2.md Deletes all SNMP alerts associated with the specified site. ```API Documentation Parameters: - Name: id, Located in: path, Description: The identifier of the site., Required: Yes, Schema: integer Responses: - Code: 200, Description: OK, Schema: [Links](#links) - Code: 401, Description: Unauthorized, Schema: [UnauthorizedError](#unauthorizederror) - Code: 404, Description: Not Found, Schema: [NotFoundError](#notfounderror) - Code: 500, Description: Internal Server Error, Schema: [InternalServerError](#internalservererror) - Code: 503, Description: Service Unavailable, Schema: [ServiceUnavailableError](#serviceunavailableerror) ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.