Select the tab
ESET Connect – Table of Contents

GET List device patches

Relative path: /v1/device-patches

If the same application, package or operating system is unpatched on multiple devices, the collection would contain entities for each device and patch individually.

The list may be empty if no patches for any device are found.

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






Query parameters

Name

Type

Description

deviceUuid

string

Reference to the device whose vulnerabilities should be listed.

If empty or null, vulnerabilities of any device accessible to the caller will be included in the response.

type: vulnerability_management.v1.VulnerableDevice

deviceGroupUuid

string

Reference to the [device group] for which the vulnerable devices should be listed. Devices of the nested groups are listed recursively as well.

If empty or null, any device accessible to the caller will be included in the response.

type: device_management.v1.DeviceGroup

patchType

string

Possible categories of vulnerabilities.

PATCH_TYPE_UNSPECIFIED: fallback

PATCH_TYPE_APPLICATION: Application patch.

PATCH_TYPE_OPERATING_SYSTEM: Operating system patch.

PATCH_TYPE_PACKAGE: Package patch.

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

{
  "devices": [
    {
      "deviceUuid": "string",
      "deviceGroupUuid": "string",
      "applicationPatch": {
        "catalogId": 0,
        "category": "PATCH_CATEGORY_UNSPECIFIED",
        "developerDisplayName": "string",
        "fixedCves": [
          "string"
        ],
        "releaseDate": {
          "year": 0,
          "month": 0,
          "day": 0
        },
        "releaseNotesUrl": "string",
        "restartRequired": "RESTART_REQUIREMENT_UNSPECIFIED",
        "resultVersionName": "string",
        "severity": "SEVERITY_LEVEL_UNSPECIFIED",
        "termsUrl": "string"
      },
      "osPatch": {
        "osFamilyId": 0,
        "catalogId": 0,
        "category": "PATCH_CATEGORY_UNSPECIFIED",
        "developerDisplayName": "string",
        "fixedCves": [
          "string"
        ],
        "releaseDate": {
          "year": 0,
          "month": 0,
          "day": 0
        },
        "releaseNotesUrl": "string",
        "restartRequired": "RESTART_REQUIREMENT_UNSPECIFIED",
        "resultVersionName": "string",
        "severity": "SEVERITY_LEVEL_UNSPECIFIED",
        "termsUrl": "string"
      },
      "packagePatch": {
        "dependencies": [
          {
            "displayName": "string",
            "name": "string",
            "packageManagerType": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
            "reference": "string",
            "versionName": "string"
          }
        ],
        "package": {
          "displayName": "string",
          "name": "string",
          "packageManagerType": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
          "reference": "string",
          "versionName": "string"
        },
        "catalogId": 0,
        "category": "PATCH_CATEGORY_UNSPECIFIED",
        "developerDisplayName": "string",
        "fixedCves": [
          "string"
        ],
        "releaseDate": {
          "year": 0,
          "month": 0,
          "day": 0
        },
        "releaseNotesUrl": "string",
        "restartRequired": "RESTART_REQUIREMENT_UNSPECIFIED",
        "resultVersionName": "string",
        "severity": "SEVERITY_LEVEL_UNSPECIFIED",
        "termsUrl": "string"
      },
      "uuid": "string"
    }
  ],
  "nextPageToken": "string"
}

Successful response.


Response schema

{
  "$ref": "v1ListDevicePatchesResponse",
  "devices": [
    {
      "$ref": "v1DevicePatch",
      "description": "Descriptor of a patch for a device. Two device patches from two different devices might point to the same patch in the patch catalog, even though they are two distinct cases with unique identifiers. There are as many device patch entries as there are patches ready for the same device. For example, a device with two unpatched applications and an outdated operating system will be represented as three device patch entities. If there is another device with the same unpatched applications and operating system, it will be represented by three more device patch entities. Each patch can be applied individually.",
      "deviceUuid": {
        "type": "string",
        "description": "Reference to the unpatched [device]. type: device_management.v1.Device"
      },
      "deviceGroupUuid": {
        "type": "string",
        "description": "Reference to the parent group of the device. type: device_management.v1.DeviceGroup"
      },
      "applicationPatch": {
        "$ref": "v1ApplicationPatch",
        "description": "Describes an application patch. The same patch is applicable to multiple versions of an application. //// Inherited from Patch /////",
        "catalogId": {
          "type": "integer",
          "description": "Identifier of an item in the package catalog. Some patches (especially third-party, such as package patches) might not have an entry in the package catalog.",
          "format": "int64"
        },
        "category": {
          "$ref": "v1PatchCategory",
          "type": "string",
          "description": "Describes what gets fixed by applying the patch to the application. Whether security-related issues or something else. PATCH_CATEGORY_UNSPECIFIED: fallback PATCH_CATEGORY_SECURITY_UPDATE: This patch fixes a security-related issue of the application. PATCH_CATEGORY_REGULAR_UPDATE: Patch updates the application without any security-related fixes.",
          "default": "PATCH_CATEGORY_UNSPECIFIED",
          "enum": [
            "PATCH_CATEGORY_UNSPECIFIED",
            "PATCH_CATEGORY_SECURITY_UPDATE",
            "PATCH_CATEGORY_REGULAR_UPDATE"
          ]
        },
        "developerDisplayName": {
          "type": "string",
          "description": "A human-readable name of a developer (vendor) of the patch."
        },
        "fixedCves": [
          {
            "type": "string"
          }
        ],
        "releaseDate": {
          "$ref": "typeDate",
          "description": "A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.",
          "year": {
            "type": "integer",
            "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
            "format": "int32"
          },
          "month": {
            "type": "integer",
            "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
            "format": "int32"
          },
          "day": {
            "type": "integer",
            "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
            "format": "int32"
          }
        },
        "releaseNotesUrl": {
          "type": "string",
          "description": "Link to information attached to this patch, for example, changelog or release notes in general."
        },
        "restartRequired": {
          "$ref": "v1RestartRequirement",
          "title": "Possible answers to the question: Is restart required?",
          "type": "string",
          "description": "RESTART_REQUIREMENT_UNSPECIFIED: Maybe it is required, maybe it is not. A fallback. RESTART_REQUIREMENT_YES: Yes, restart is required. RESTART_REQUIREMENT_NO: No restart is required.",
          "default": "RESTART_REQUIREMENT_UNSPECIFIED",
          "enum": [
            "RESTART_REQUIREMENT_UNSPECIFIED",
            "RESTART_REQUIREMENT_YES",
            "RESTART_REQUIREMENT_NO"
          ]
        },
        "resultVersionName": {
          "type": "string",
          "description": "Result version reached after the patch is applied. Info: If the patch is not from the catalog, the version is informative. For example, Chrome does not publish the patch to a certain version; it always patches to the latest version. If the patching is requested after a longer time, the actual version might be later than reported."
        },
        "severity": {
          "$ref": "v1SeverityLevel",
          "type": "string",
          "description": "Severity levels abstracted to cover all the possible GUIs. Vocabulary is leaving interpretation of severity level completely to API client. This approach is inevitable on SIEM level as there are many contributing sources. Keeping the local names for severity levels never fits all the GUIs. SEVERITY_LEVEL_UNSPECIFIED: fallback SEVERITY_LEVEL_DIAGNOSTIC: In some GUIs known Debug SEVERITY_LEVEL_INFORMATIONAL: In some GUIs known as Info or Information SEVERITY_LEVEL_LOW: In some GUIs known Warning SEVERITY_LEVEL_MEDIUM: In some GUIs known as Error or Threat SEVERITY_LEVEL_HIGH: In some GUIs known as Critical",
          "default": "SEVERITY_LEVEL_UNSPECIFIED",
          "enum": [
            "SEVERITY_LEVEL_UNSPECIFIED",
            "SEVERITY_LEVEL_DIAGNOSTIC",
            "SEVERITY_LEVEL_INFORMATIONAL",
            "SEVERITY_LEVEL_LOW",
            "SEVERITY_LEVEL_MEDIUM",
            "SEVERITY_LEVEL_HIGH"
          ]
        },
        "termsUrl": {
          "type": "string",
          "description": "Link to terms (EULA, Terms of Use, Terms of Service, etc.)."
        }
      },
      "osPatch": {
        "$ref": "v1OsPatch",
        "description": "Describes an operating system patch. The same patch is applicable to multiple versions of an operating system.",
        "osFamilyId": {
          "type": "integer",
          "description": "Family of the operating system. The family comprises the whole series of related operating systems. Some families feature multiple editions, for example, MacOS versus MacOS Server. Use a value from the following list: Value Description 1 Windows 2 Linux 3 Mac OS 7 Unix type: os_catalog.v2.OsFamily",
          "format": "int64"
        },
        "catalogId": {
          "type": "integer",
          "description": "Identifier of an item in the package catalog. Some patches (especially third-party, such as package patches) might not have an entry in the package catalog.",
          "format": "int64"
        },
        "category": {
          "$ref": "v1PatchCategory",
          "type": "string",
          "description": "Describes what gets fixed by applying the patch to the application. Whether security-related issues or something else. PATCH_CATEGORY_UNSPECIFIED: fallback PATCH_CATEGORY_SECURITY_UPDATE: This patch fixes a security-related issue of the application. PATCH_CATEGORY_REGULAR_UPDATE: Patch updates the application without any security-related fixes.",
          "default": "PATCH_CATEGORY_UNSPECIFIED",
          "enum": [
            "PATCH_CATEGORY_UNSPECIFIED",
            "PATCH_CATEGORY_SECURITY_UPDATE",
            "PATCH_CATEGORY_REGULAR_UPDATE"
          ]
        },
        "developerDisplayName": {
          "type": "string",
          "description": "A human-readable name of a developer (vendor) of the patch."
        },
        "fixedCves": [
          {
            "type": "string"
          }
        ],
        "releaseDate": {
          "$ref": "typeDate",
          "description": "A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.",
          "year": {
            "type": "integer",
            "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
            "format": "int32"
          },
          "month": {
            "type": "integer",
            "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
            "format": "int32"
          },
          "day": {
            "type": "integer",
            "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
            "format": "int32"
          }
        },
        "releaseNotesUrl": {
          "type": "string",
          "description": "Link to information attached to this patch, for example, changelog or release notes in general."
        },
        "restartRequired": {
          "$ref": "v1RestartRequirement",
          "title": "Possible answers to the question: Is restart required?",
          "type": "string",
          "description": "RESTART_REQUIREMENT_UNSPECIFIED: Maybe it is required, maybe it is not. A fallback. RESTART_REQUIREMENT_YES: Yes, restart is required. RESTART_REQUIREMENT_NO: No restart is required.",
          "default": "RESTART_REQUIREMENT_UNSPECIFIED",
          "enum": [
            "RESTART_REQUIREMENT_UNSPECIFIED",
            "RESTART_REQUIREMENT_YES",
            "RESTART_REQUIREMENT_NO"
          ]
        },
        "resultVersionName": {
          "type": "string",
          "description": "Result version reached after the patch is applied. Info: If the patch is not from the catalog, the version is informative. For example, Chrome does not publish the patch to a certain version; it always patches to the latest version. If the patching is requested after a longer time, the actual version might be later than reported."
        },
        "severity": {
          "$ref": "v1SeverityLevel",
          "type": "string",
          "description": "Severity levels abstracted to cover all the possible GUIs. Vocabulary is leaving interpretation of severity level completely to API client. This approach is inevitable on SIEM level as there are many contributing sources. Keeping the local names for severity levels never fits all the GUIs. SEVERITY_LEVEL_UNSPECIFIED: fallback SEVERITY_LEVEL_DIAGNOSTIC: In some GUIs known Debug SEVERITY_LEVEL_INFORMATIONAL: In some GUIs known as Info or Information SEVERITY_LEVEL_LOW: In some GUIs known Warning SEVERITY_LEVEL_MEDIUM: In some GUIs known as Error or Threat SEVERITY_LEVEL_HIGH: In some GUIs known as Critical",
          "default": "SEVERITY_LEVEL_UNSPECIFIED",
          "enum": [
            "SEVERITY_LEVEL_UNSPECIFIED",
            "SEVERITY_LEVEL_DIAGNOSTIC",
            "SEVERITY_LEVEL_INFORMATIONAL",
            "SEVERITY_LEVEL_LOW",
            "SEVERITY_LEVEL_MEDIUM",
            "SEVERITY_LEVEL_HIGH"
          ]
        },
        "termsUrl": {
          "type": "string",
          "description": "Link to terms (EULA, Terms of Use, Terms of Service, etc.)."
        }
      },
      "packagePatch": {
        "$ref": "v1PackagePatch",
        "description": "Describes a package patch. The same patch is applicable to multiple versions of a package.",
        "dependencies": [
          {
            "$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"
            }
          }
        ],
        "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"
          }
        },
        "catalogId": {
          "type": "integer",
          "description": "Identifier of an item in the package catalog. Some patches (especially third-party, such as package patches) might not have an entry in the package catalog.",
          "format": "int64"
        },
        "category": {
          "$ref": "v1PatchCategory",
          "type": "string",
          "description": "Describes what gets fixed by applying the patch to the application. Whether security-related issues or something else. PATCH_CATEGORY_UNSPECIFIED: fallback PATCH_CATEGORY_SECURITY_UPDATE: This patch fixes a security-related issue of the application. PATCH_CATEGORY_REGULAR_UPDATE: Patch updates the application without any security-related fixes.",
          "default": "PATCH_CATEGORY_UNSPECIFIED",
          "enum": [
            "PATCH_CATEGORY_UNSPECIFIED",
            "PATCH_CATEGORY_SECURITY_UPDATE",
            "PATCH_CATEGORY_REGULAR_UPDATE"
          ]
        },
        "developerDisplayName": {
          "type": "string",
          "description": "A human-readable name of a developer (vendor) of the patch."
        },
        "fixedCves": [
          {
            "type": "string"
          }
        ],
        "releaseDate": {
          "$ref": "typeDate",
          "description": "A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.",
          "year": {
            "type": "integer",
            "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
            "format": "int32"
          },
          "month": {
            "type": "integer",
            "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
            "format": "int32"
          },
          "day": {
            "type": "integer",
            "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
            "format": "int32"
          }
        },
        "releaseNotesUrl": {
          "type": "string",
          "description": "Link to information attached to this patch, for example, changelog or release notes in general."
        },
        "restartRequired": {
          "$ref": "v1RestartRequirement",
          "title": "Possible answers to the question: Is restart required?",
          "type": "string",
          "description": "RESTART_REQUIREMENT_UNSPECIFIED: Maybe it is required, maybe it is not. A fallback. RESTART_REQUIREMENT_YES: Yes, restart is required. RESTART_REQUIREMENT_NO: No restart is required.",
          "default": "RESTART_REQUIREMENT_UNSPECIFIED",
          "enum": [
            "RESTART_REQUIREMENT_UNSPECIFIED",
            "RESTART_REQUIREMENT_YES",
            "RESTART_REQUIREMENT_NO"
          ]
        },
        "resultVersionName": {
          "type": "string",
          "description": "Result version reached after the patch is applied. Info: If the patch is not from the catalog, the version is informative. For example, Chrome does not publish the patch to certain version; it always patches to the latest version. If patching is requested after a longer time, the actual version might be later than reported."
        },
        "severity": {
          "$ref": "v1SeverityLevel",
          "type": "string",
          "description": "Severity levels abstracted to cover all the possible GUIs. Vocabulary is leaving interpretation of severity level completely to API client. This approach is inevitable on SIEM level as there are many contributing sources. Keeping the local names for severity levels never fits all the GUIs. SEVERITY_LEVEL_UNSPECIFIED: fallback SEVERITY_LEVEL_DIAGNOSTIC: In some GUIs known Debug SEVERITY_LEVEL_INFORMATIONAL: In some GUIs known as Info or Information SEVERITY_LEVEL_LOW: In some GUIs known Warning SEVERITY_LEVEL_MEDIUM: In some GUIs known as Error or Threat SEVERITY_LEVEL_HIGH: In some GUIs known as Critical",
          "default": "SEVERITY_LEVEL_UNSPECIFIED",
          "enum": [
            "SEVERITY_LEVEL_UNSPECIFIED",
            "SEVERITY_LEVEL_DIAGNOSTIC",
            "SEVERITY_LEVEL_INFORMATIONAL",
            "SEVERITY_LEVEL_LOW",
            "SEVERITY_LEVEL_MEDIUM",
            "SEVERITY_LEVEL_HIGH"
          ]
        },
        "termsUrl": {
          "type": "string",
          "description": "Link to terms (EULA, Terms of Use, Terms of Service, etc.)."
        }
      },
      "uuid": {
        "type": "string",
        "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within the entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 9562: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier, albeit of predictable length and alphabet. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
      }
    }
  ],
  "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"
    }
  }
}