Select the tab
ESET Connect – Table of Contents

GET List patching details

Relative path: /v1/patching-process-details

History is pruned repeatedly to prevent database flooding. Entries from at least the previous 30 days should be available at any time.

Endpoint URL for Europe, Germany, United States, Canada and Japan regions:






Query parameters

Name

Type

Description

deviceUuid

string

Reference to the device whose patching details should be listed.

If empty or null, patching details of all devices accessible to the caller will be included in the response.

type: device_management.v1.Device

deviceGroupUuid

string

Reference to the [device group].

If filled, only the patching details of devices within the group will be included in the response. If empty or null, scan details of any device accessible to the caller will be included in the response.

type: device_management.v1.DeviceGroup

timePeriod.startTime

string

Optional. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

timePeriod.endTime

string

Optional. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.

pageSize

integer

Limit for pagination purposes.

If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

pageToken

string

Page token of the current page.

If not given or "", the first page is returned.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination



Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

Successful response.


Response example

{
  "patchingDetails": [
    {
      "dependencies": [
        {
          "actionType": "PATCH_ACTION_TYPE_UNSPECIFIED",
          "package": {
            "displayName": "string",
            "name": "string",
            "packageManagerType": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
            "reference": "string",
            "versionName": "string"
          }
        }
      ],
      "deviceUuid": "string",
      "displayName": "string",
      "application": {
        "applicationUuid": "string",
        "developerDisplayName": "string",
        "displayName": "string",
        "patchedVersion": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        },
        "status": "APPLICATION_PATCHING_STATUS_UNSPECIFIED",
        "timePeriod": {
          "startTime": "string",
          "endTime": "string"
        },
        "unpatchedVersion": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        }
      },
      "operatingSystem": {
        "actionType": "PATCH_ACTION_TYPE_UNSPECIFIED",
        "osFamilyId": 0,
        "patchedVersion": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        },
        "status": "PATCHING_STATUS_UNSPECIFIED",
        "timePeriod": {
          "startTime": "string",
          "endTime": "string"
        },
        "unpatchedVersion": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        }
      },
      "package": {
        "dependencies": [
          null
        ],
        "packageReference": "string",
        "patchedVersion": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        },
        "status": "PATCHING_STATUS_UNSPECIFIED",
        "timePeriod": {
          "startTime": "string",
          "endTime": "string"
        },
        "unpatchedVersion": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        }
      }
    }
  ],
  "nextPageToken": "string"
}

Successful response.


Response schema

{
  "$ref": "v1ListDevicePatchingDetailsResponse",
  "patchingDetails": [
    {
      "$ref": "v1DevicePatchingDetails",
      "description": "Details of patching of a single application or package.",
      "dependencies": [
        {
          "$ref": "v1DependencyPatchingDetails",
          "description": "Details of dependency patching. Patching process, to be finished, might have dependencies.",
          "actionType": {
            "$ref": "v1PatchActionType",
            "type": "string",
            "description": "Possible outcomes of patching in terms of the application or package lifecycle. PATCH_ACTION_TYPE_UNSPECIFIED: fallback PATCH_ACTION_TYPE_ADDED: Application or package was added (installed) to the system. PATCH_ACTION_TYPE_UPGRADED: Application or package was upgraded. PATCH_ACTION_TYPE_DOWNGRADED: Application or package was downgraded. PATCH_ACTION_TYPE_REMOVED: Application or package was removed (uninstalled) from the system.",
            "default": "PATCH_ACTION_TYPE_UNSPECIFIED",
            "enum": [
              "PATCH_ACTION_TYPE_UNSPECIFIED",
              "PATCH_ACTION_TYPE_ADDED",
              "PATCH_ACTION_TYPE_UPGRADED",
              "PATCH_ACTION_TYPE_DOWNGRADED",
              "PATCH_ACTION_TYPE_REMOVED"
            ]
          },
          "package": {
            "$ref": "v1Package",
            "description": "Package descriptor. Packages are referenced by their name and provider.",
            "displayName": {
              "type": "string",
              "description": "A human-friendly name of the package. For example: 'Firefox'"
            },
            "name": {
              "type": "string",
              "description": "Package name as indexed within the package manager. Package name identifies a package only in the context of one package manager. The name is not globally unique. For example: 'com.example.app123'"
            },
            "packageManagerType": {
              "$ref": "v1PackageManagerType",
              "type": "string",
              "description": "Possible types of package managers. Package managers are used to install and manage packages on the system. PACKAGE_MANAGER_TYPE_UNSPECIFIED: fallback PACKAGE_MANAGER_TYPE_APT: Advanced Packaging Type For details, refer to APT - PACKAGE_MANAGER_TYPE_SNAP: Package Manager for Snap For details, refer to Snap - PACKAGE_MANAGER_TYPE_DNF: Dandified YUM For details, refer to DNF",
              "default": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
              "enum": [
                "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
                "PACKAGE_MANAGER_TYPE_APT",
                "PACKAGE_MANAGER_TYPE_SNAP",
                "PACKAGE_MANAGER_TYPE_DNF"
              ]
            },
            "reference": {
              "type": "string",
              "description": "Reference to the package. Reference is an opaque string that identifies the package."
            },
            "versionName": {
              "type": "string",
              "description": "A human-readable name of the package version. For example: - 2.12 - 1.1.2j - 1:4.8.1-2ubuntu2.2 - 2:1.02.175-2.1ubuntu4 - 2:1.02.175-2.1ubuntu5 - 21H2 1233.223"
            }
          }
        }
      ],
      "deviceUuid": {
        "type": "string",
        "description": "Reference to the [device] where patching occurred. type: device_management.v1.Device"
      },
      "displayName": {
        "type": "string",
        "description": "A human-friendly name of the application or package."
      },
      "application": {
        "$ref": "v1ApplicationPatchingDetails",
        "description": "Details of patching of a single application.",
        "applicationUuid": {
          "type": "string",
          "description": "Reference to the patched [application]. type: application_management.v1.Application"
        },
        "developerDisplayName": {
          "type": "string",
          "description": "Developer of the application."
        },
        "displayName": {
          "type": "string",
          "description": "A human-friendly name of the application."
        },
        "patchedVersion": {
          "$ref": "v1Version",
          "description": "Version descriptor. Both values are required to completely reconstruct version information.",
          "id": {
            "type": "string",
            "description": "[Version id] determines whether one version is more recent than another. More recent versions have higher numbers. Can be processed by machine. If human readable version_name meets certain criteria, it can be converted to version_id automatically. The cases are: Windows => VersionId = MajorVersion << 48 | MinorVersion << 32 | ServicePackMajor << 24 | ServicePackMinor << 16 | CurrentBuildNumber Android => VersionId = API level YYYYMMDD => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 | (DD & 0xffff) <<16 YYYY.MM => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 YY.MM => VersionId = (YY & 0xffff ) << 48 | (MM & 0xffff) << 32 YYYY => VersionId = (YYYY & 0xffff ) << 48 Major.Minor.Patch => VersionId = (Major & 0xffff ) << 48 | (Minor & 0xffff) << 32 | (Patch & 0xffff) <<16 EULA | Terms of Use => VersionId = MajorVersion << 48 | MinorVersion << 32 | Patch << 16 A.B.C.D => VersionId = (A & 0xffff) << 48 | (B & 0xffff) << 32 | (C & 0xffff) << 16 | (D & 0xffff) A.B.C => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 | (C & 0xffff) <<16 A.B => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 A => VersionId = (A & 0xffff ) << 48",
            "format": "uint64"
          },
          "major": {
            "type": "integer",
            "description": "Major version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "minor": {
            "type": "integer",
            "description": "Minor version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Human readable name of the version. E.g. '10.2.3.145'"
          },
          "patch": {
            "type": "integer",
            "description": "Patch if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          }
        },
        "status": {
          "$ref": "v1ApplicationPatchingStatus",
          "type": "string",
          "description": "Possible statuses of application patching. DEPRECATED: Use PatchingStatus instead. APPLICATION_PATCHING_STATUS_UNSPECIFIED: fallback APPLICATION_PATCHING_STATUS_OK_INSTALLED: Patching was successful and complete. APPLICATION_PATCHING_STATUS_OK_RESTART_REQUIRED: Patching was successful, but system restart is required. APPLICATION_PATCHING_STATUS_FAILED_TERMINATION_REQUIRED: Patching was unsuccessful, application must be terminated before patching. APPLICATION_PATCHING_STATUS_FAILED_UNINSTALL_REQUIRED: Patching was unsuccessful, application must be uninstalled before patching. APPLICATION_PATCHING_STATUS_FAILED_DOWNLOAD_ERROR: Patching was unsuccessful, patch downloading failed. APPLICATION_PATCHING_STATUS_FAILED_INSTALLER_CORRUPTED: Patching was unsuccessful, downloaded patch installer was corrupted. APPLICATION_PATCHING_STATUS_FAILED_PREPARE_ERROR: Patching was unsuccessful, failed to prepare downloaded patch installer. APPLICATION_PATCHING_STATUS_NOT_APPLICABLE: Patching was unsuccessful, patch is not applicable - already patched/uninstalled.",
          "default": "APPLICATION_PATCHING_STATUS_UNSPECIFIED",
          "enum": [
            "APPLICATION_PATCHING_STATUS_UNSPECIFIED",
            "APPLICATION_PATCHING_STATUS_OK_INSTALLED",
            "APPLICATION_PATCHING_STATUS_OK_RESTART_REQUIRED",
            "APPLICATION_PATCHING_STATUS_FAILED_TERMINATION_REQUIRED",
            "APPLICATION_PATCHING_STATUS_FAILED_UNINSTALL_REQUIRED",
            "APPLICATION_PATCHING_STATUS_FAILED_DOWNLOAD_ERROR",
            "APPLICATION_PATCHING_STATUS_FAILED_INSTALLER_CORRUPTED",
            "APPLICATION_PATCHING_STATUS_FAILED_PREPARE_ERROR",
            "APPLICATION_PATCHING_STATUS_NOT_APPLICABLE"
          ]
        },
        "timePeriod": {
          "$ref": "typeInterval",
          "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.",
          "startTime": {
            "type": "string",
            "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
            "format": "date-time"
          },
          "endTime": {
            "type": "string",
            "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
            "format": "date-time"
          }
        },
        "unpatchedVersion": {
          "$ref": "v1Version",
          "description": "Version descriptor. Both values are required to completely reconstruct version information.",
          "id": {
            "type": "string",
            "description": "[Version id] determines whether one version is more recent than another. More recent versions have higher numbers. Can be processed by machine. If human readable version_name meets certain criteria, it can be converted to version_id automatically. The cases are: Windows => VersionId = MajorVersion << 48 | MinorVersion << 32 | ServicePackMajor << 24 | ServicePackMinor << 16 | CurrentBuildNumber Android => VersionId = API level YYYYMMDD => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 | (DD & 0xffff) <<16 YYYY.MM => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 YY.MM => VersionId = (YY & 0xffff ) << 48 | (MM & 0xffff) << 32 YYYY => VersionId = (YYYY & 0xffff ) << 48 Major.Minor.Patch => VersionId = (Major & 0xffff ) << 48 | (Minor & 0xffff) << 32 | (Patch & 0xffff) <<16 EULA | Terms of Use => VersionId = MajorVersion << 48 | MinorVersion << 32 | Patch << 16 A.B.C.D => VersionId = (A & 0xffff) << 48 | (B & 0xffff) << 32 | (C & 0xffff) << 16 | (D & 0xffff) A.B.C => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 | (C & 0xffff) <<16 A.B => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 A => VersionId = (A & 0xffff ) << 48",
            "format": "uint64"
          },
          "major": {
            "type": "integer",
            "description": "Major version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "minor": {
            "type": "integer",
            "description": "Minor version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Human readable name of the version. E.g. '10.2.3.145'"
          },
          "patch": {
            "type": "integer",
            "description": "Patch if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          }
        }
      },
      "operatingSystem": {
        "$ref": "v1OsPatchingDetails",
        "description": "Details of patching of an operating system.",
        "actionType": {
          "$ref": "v1PatchActionType",
          "type": "string",
          "description": "Possible outcomes of patching in terms of the application or package lifecycle. PATCH_ACTION_TYPE_UNSPECIFIED: fallback PATCH_ACTION_TYPE_ADDED: Application or package was added (installed) to the system. PATCH_ACTION_TYPE_UPGRADED: Application or package was upgraded. PATCH_ACTION_TYPE_DOWNGRADED: Application or package was downgraded. PATCH_ACTION_TYPE_REMOVED: Application or package was removed (uninstalled) from the system.",
          "default": "PATCH_ACTION_TYPE_UNSPECIFIED",
          "enum": [
            "PATCH_ACTION_TYPE_UNSPECIFIED",
            "PATCH_ACTION_TYPE_ADDED",
            "PATCH_ACTION_TYPE_UPGRADED",
            "PATCH_ACTION_TYPE_DOWNGRADED",
            "PATCH_ACTION_TYPE_REMOVED"
          ]
        },
        "osFamilyId": {
          "title": "Operating system family where patching occurred. Use a value from the following list:",
          "type": "integer",
          "description": "Value Description 1 Windows 2 Linux 3 Mac OS 7 Unix type: os_catalog.v2.OsFamily",
          "format": "int64"
        },
        "patchedVersion": {
          "$ref": "v1Version",
          "description": "Version descriptor. Both values are required to completely reconstruct version information.",
          "id": {
            "type": "string",
            "description": "[Version id] determines whether one version is more recent than another. More recent versions have higher numbers. Can be processed by machine. If human readable version_name meets certain criteria, it can be converted to version_id automatically. The cases are: Windows => VersionId = MajorVersion << 48 | MinorVersion << 32 | ServicePackMajor << 24 | ServicePackMinor << 16 | CurrentBuildNumber Android => VersionId = API level YYYYMMDD => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 | (DD & 0xffff) <<16 YYYY.MM => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 YY.MM => VersionId = (YY & 0xffff ) << 48 | (MM & 0xffff) << 32 YYYY => VersionId = (YYYY & 0xffff ) << 48 Major.Minor.Patch => VersionId = (Major & 0xffff ) << 48 | (Minor & 0xffff) << 32 | (Patch & 0xffff) <<16 EULA | Terms of Use => VersionId = MajorVersion << 48 | MinorVersion << 32 | Patch << 16 A.B.C.D => VersionId = (A & 0xffff) << 48 | (B & 0xffff) << 32 | (C & 0xffff) << 16 | (D & 0xffff) A.B.C => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 | (C & 0xffff) <<16 A.B => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 A => VersionId = (A & 0xffff ) << 48",
            "format": "uint64"
          },
          "major": {
            "type": "integer",
            "description": "Major version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "minor": {
            "type": "integer",
            "description": "Minor version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Human readable name of the version. E.g. '10.2.3.145'"
          },
          "patch": {
            "type": "integer",
            "description": "Patch if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          }
        },
        "status": {
          "$ref": "v1PatchingStatus",
          "type": "string",
          "description": "Possible statuses of patching. PATCHING_STATUS_UNSPECIFIED: fallback PATCHING_STATUS_OK_INSTALLED: Patching was successful and complete. PATCHING_STATUS_OK_RESTART_REQUIRED: Patching was successful, but system restart is required. PATCHING_STATUS_FAILED_TERMINATION_REQUIRED: Patching was unsuccessful, application must be terminated before patching. PATCHING_STATUS_FAILED_UNINSTALL_REQUIRED: Patching was unsuccessful, application must be uninstalled before patching. PATCHING_STATUS_FAILED_DOWNLOAD_ERROR: Patching was unsuccessful, patch downloading failed. PATCHING_STATUS_FAILED_INSTALLER_CORRUPTED: Patching was unsuccessful, downloaded patch installer was corrupted. PATCHING_STATUS_FAILED_PREPARE_ERROR: Patching was unsuccessful, failed to prepare downloaded patch installer. PATCHING_STATUS_NOT_APPLICABLE: Patching was unsuccessful, patch is not applicable - already patched/uninstalled. PATCHING_STATUS_AVAILABLE: Patching is possible, not yet scheduled nor executed. PATCHING_STATUS_SCHEDULED: Patching is scheduled, not yet executed.",
          "default": "PATCHING_STATUS_UNSPECIFIED",
          "enum": [
            "PATCHING_STATUS_UNSPECIFIED",
            "PATCHING_STATUS_OK_INSTALLED",
            "PATCHING_STATUS_OK_RESTART_REQUIRED",
            "PATCHING_STATUS_FAILED_TERMINATION_REQUIRED",
            "PATCHING_STATUS_FAILED_UNINSTALL_REQUIRED",
            "PATCHING_STATUS_FAILED_DOWNLOAD_ERROR",
            "PATCHING_STATUS_FAILED_INSTALLER_CORRUPTED",
            "PATCHING_STATUS_FAILED_PREPARE_ERROR",
            "PATCHING_STATUS_NOT_APPLICABLE",
            "PATCHING_STATUS_AVAILABLE",
            "PATCHING_STATUS_SCHEDULED"
          ]
        },
        "timePeriod": {
          "$ref": "typeInterval",
          "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.",
          "startTime": {
            "type": "string",
            "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
            "format": "date-time"
          },
          "endTime": {
            "type": "string",
            "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
            "format": "date-time"
          }
        },
        "unpatchedVersion": {
          "$ref": "v1Version",
          "description": "Version descriptor. Both values are required to completely reconstruct version information.",
          "id": {
            "type": "string",
            "description": "[Version id] determines whether one version is more recent than another. More recent versions have higher numbers. Can be processed by machine. If human readable version_name meets certain criteria, it can be converted to version_id automatically. The cases are: Windows => VersionId = MajorVersion << 48 | MinorVersion << 32 | ServicePackMajor << 24 | ServicePackMinor << 16 | CurrentBuildNumber Android => VersionId = API level YYYYMMDD => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 | (DD & 0xffff) <<16 YYYY.MM => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 YY.MM => VersionId = (YY & 0xffff ) << 48 | (MM & 0xffff) << 32 YYYY => VersionId = (YYYY & 0xffff ) << 48 Major.Minor.Patch => VersionId = (Major & 0xffff ) << 48 | (Minor & 0xffff) << 32 | (Patch & 0xffff) <<16 EULA | Terms of Use => VersionId = MajorVersion << 48 | MinorVersion << 32 | Patch << 16 A.B.C.D => VersionId = (A & 0xffff) << 48 | (B & 0xffff) << 32 | (C & 0xffff) << 16 | (D & 0xffff) A.B.C => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 | (C & 0xffff) <<16 A.B => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 A => VersionId = (A & 0xffff ) << 48",
            "format": "uint64"
          },
          "major": {
            "type": "integer",
            "description": "Major version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "minor": {
            "type": "integer",
            "description": "Minor version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Human readable name of the version. E.g. '10.2.3.145'"
          },
          "patch": {
            "type": "integer",
            "description": "Patch if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          }
        }
      },
      "package": {
        "$ref": "v1PackagePatchingDetails",
        "description": "Details of patching of a single package.",
        "dependencies": [
          {
            "$ref": "v1DevicePatchingDetails"
          }
        ],
        "packageReference": {
          "type": "string",
          "description": "Reference to the patched package."
        },
        "patchedVersion": {
          "$ref": "v1Version",
          "description": "Version descriptor. Both values are required to completely reconstruct version information.",
          "id": {
            "type": "string",
            "description": "[Version id] determines whether one version is more recent than another. More recent versions have higher numbers. Can be processed by machine. If human readable version_name meets certain criteria, it can be converted to version_id automatically. The cases are: Windows => VersionId = MajorVersion << 48 | MinorVersion << 32 | ServicePackMajor << 24 | ServicePackMinor << 16 | CurrentBuildNumber Android => VersionId = API level YYYYMMDD => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 | (DD & 0xffff) <<16 YYYY.MM => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 YY.MM => VersionId = (YY & 0xffff ) << 48 | (MM & 0xffff) << 32 YYYY => VersionId = (YYYY & 0xffff ) << 48 Major.Minor.Patch => VersionId = (Major & 0xffff ) << 48 | (Minor & 0xffff) << 32 | (Patch & 0xffff) <<16 EULA | Terms of Use => VersionId = MajorVersion << 48 | MinorVersion << 32 | Patch << 16 A.B.C.D => VersionId = (A & 0xffff) << 48 | (B & 0xffff) << 32 | (C & 0xffff) << 16 | (D & 0xffff) A.B.C => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 | (C & 0xffff) <<16 A.B => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 A => VersionId = (A & 0xffff ) << 48",
            "format": "uint64"
          },
          "major": {
            "type": "integer",
            "description": "Major version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "minor": {
            "type": "integer",
            "description": "Minor version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Human readable name of the version. E.g. '10.2.3.145'"
          },
          "patch": {
            "type": "integer",
            "description": "Patch if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          }
        },
        "status": {
          "$ref": "v1PatchingStatus",
          "type": "string",
          "description": "Possible statuses of patching. PATCHING_STATUS_UNSPECIFIED: fallback PATCHING_STATUS_OK_INSTALLED: Patching was successful and complete. PATCHING_STATUS_OK_RESTART_REQUIRED: Patching was successful, but system restart is required. PATCHING_STATUS_FAILED_TERMINATION_REQUIRED: Patching was unsuccessful, application must be terminated before patching. PATCHING_STATUS_FAILED_UNINSTALL_REQUIRED: Patching was unsuccessful, application must be uninstalled before patching. PATCHING_STATUS_FAILED_DOWNLOAD_ERROR: Patching was unsuccessful, patch downloading failed. PATCHING_STATUS_FAILED_INSTALLER_CORRUPTED: Patching was unsuccessful, downloaded patch installer was corrupted. PATCHING_STATUS_FAILED_PREPARE_ERROR: Patching was unsuccessful, failed to prepare downloaded patch installer. PATCHING_STATUS_NOT_APPLICABLE: Patching was unsuccessful, patch is not applicable - already patched/uninstalled. PATCHING_STATUS_AVAILABLE: Patching is possible, not yet scheduled nor executed. PATCHING_STATUS_SCHEDULED: Patching is scheduled, not yet executed.",
          "default": "PATCHING_STATUS_UNSPECIFIED",
          "enum": [
            "PATCHING_STATUS_UNSPECIFIED",
            "PATCHING_STATUS_OK_INSTALLED",
            "PATCHING_STATUS_OK_RESTART_REQUIRED",
            "PATCHING_STATUS_FAILED_TERMINATION_REQUIRED",
            "PATCHING_STATUS_FAILED_UNINSTALL_REQUIRED",
            "PATCHING_STATUS_FAILED_DOWNLOAD_ERROR",
            "PATCHING_STATUS_FAILED_INSTALLER_CORRUPTED",
            "PATCHING_STATUS_FAILED_PREPARE_ERROR",
            "PATCHING_STATUS_NOT_APPLICABLE",
            "PATCHING_STATUS_AVAILABLE",
            "PATCHING_STATUS_SCHEDULED"
          ]
        },
        "timePeriod": {
          "$ref": "typeInterval",
          "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.",
          "startTime": {
            "type": "string",
            "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
            "format": "date-time"
          },
          "endTime": {
            "type": "string",
            "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
            "format": "date-time"
          }
        },
        "unpatchedVersion": {
          "$ref": "v1Version",
          "description": "Version descriptor. Both values are required to completely reconstruct version information.",
          "id": {
            "type": "string",
            "description": "[Version id] determines whether one version is more recent than another. More recent versions have higher numbers. Can be processed by machine. If human readable version_name meets certain criteria, it can be converted to version_id automatically. The cases are: Windows => VersionId = MajorVersion << 48 | MinorVersion << 32 | ServicePackMajor << 24 | ServicePackMinor << 16 | CurrentBuildNumber Android => VersionId = API level YYYYMMDD => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 | (DD & 0xffff) <<16 YYYY.MM => VersionId = (YYYY & 0xffff ) << 48 | (MM & 0xffff) << 32 YY.MM => VersionId = (YY & 0xffff ) << 48 | (MM & 0xffff) << 32 YYYY => VersionId = (YYYY & 0xffff ) << 48 Major.Minor.Patch => VersionId = (Major & 0xffff ) << 48 | (Minor & 0xffff) << 32 | (Patch & 0xffff) <<16 EULA | Terms of Use => VersionId = MajorVersion << 48 | MinorVersion << 32 | Patch << 16 A.B.C.D => VersionId = (A & 0xffff) << 48 | (B & 0xffff) << 32 | (C & 0xffff) << 16 | (D & 0xffff) A.B.C => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 | (C & 0xffff) <<16 A.B => VersionId = (A & 0xffff ) << 48 | (B & 0xffff) << 32 A => VersionId = (A & 0xffff ) << 48",
            "format": "uint64"
          },
          "major": {
            "type": "integer",
            "description": "Major version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "minor": {
            "type": "integer",
            "description": "Minor version if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Human readable name of the version. E.g. '10.2.3.145'"
          },
          "patch": {
            "type": "integer",
            "description": "Patch if and only if version name adheres to semantic versioning. 0 or null otherwise.",
            "format": "int64",
            "readOnly": true
          }
        }
      }
    }
  ],
  "nextPageToken": {
    "type": "string",
    "description": "Page token of the next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination"
  }
}


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

Response took too long; request cached. Response can be retrieved later using the response-id header.


Response schema

[]


Headers

{
  "response-id": {
    "description": "Unique ID of a pending request. Used to retrieve cached result.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

401

Token has expired or is invalid.

Token has expired or is invalid.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

403

Access denied. Check permissions.

Access denied. Check permissions.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

404

Requested resource not found.

Requested resource not found.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

429

Rate limit reached. Try again later.

Rate limit reached. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

500

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

502

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

503

Environment under maintenance. Try again later.

Environment under maintenance. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

504

Action took too long; timeout reached

Action took too long; timeout reached


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}