{
  "opencollection": "1.0.0",
  "info": {
    "name": "Catchpoint REST API v2.0 Account EndpointDevice API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "EndpointDevice",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns the details of endpoint devices based on the User ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/endpoints/device/:userIds",
            "params": [
              {
                "name": "userIds",
                "value": "",
                "type": "path",
                "description": "Comma-separated list of Endpoint User IDs"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the details of endpoint devices based on the User ID."
        },
        {
          "info": {
            "name": "Returns the details of endpoint devices based on the parameters passed.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/endpoints/device",
            "params": [
              {
                "name": "deviceName",
                "value": "",
                "type": "query",
                "description": "Device Name"
              },
              {
                "name": "aliasName",
                "value": "",
                "type": "query",
                "description": "Alias name of the device"
              },
              {
                "name": "statusId",
                "value": "",
                "type": "query",
                "description": "Device status. “0” for Active; “1” for Inactive"
              },
              {
                "name": "labelKeyIds",
                "value": "",
                "type": "query",
                "description": "Label ID the device is attached to"
              },
              {
                "name": "labelValueIds",
                "value": "",
                "type": "query",
                "description": "Label Value ID the device is attached to."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number to return records from when the number of records exceeds pageSize"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results that is returned per page. Maximum value is 100."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "If no parameters are passed, the properties of all active endpoint devices within the Client or Division are returned."
        },
        {
          "info": {
            "name": "Returns the endpoint device status based on the User ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/endpoints/device/status/:userIds",
            "params": [
              {
                "name": "userIds",
                "value": "",
                "type": "path",
                "description": "Comma-separated list of Endpoint User IDs"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the endpoint device status based on the User ID."
        },
        {
          "info": {
            "name": "Allows to set the status of an existing endpoint device to Active or Inactive.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/endpoints/device/status",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To get payload for updating an endpoint device status refer InternalLink[Endpoint Device Status Endpoint,operations-tag-EndpointDevice,operations-EndpointDevice-get_v2_endpoints_device_status__userIds_]. Status ID values – “0” for Active; “1” for Inactive. There can be multiple endpoint devices in the payload for which the status update is intended."
        },
        {
          "info": {
            "name": "Returns the endpoint device labels based on the User ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/endpoints/device/label/:userIds",
            "params": [
              {
                "name": "userIds",
                "value": "",
                "type": "path",
                "description": "Comma-separated list of Endpoint User IDs"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the endpoint device labels based on the User ID."
        },
        {
          "info": {
            "name": "Allows to update the existing endpoint device label.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/endpoints/device/label",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To get payload for updating an endpoint device label refer InternalLink[Endpoint Device Label Endpoint,operations-tag-EndpointDevice,operations-EndpointDevice-get_v2_endpoints_device_label__userIds_]. There can be multiple endpoint devices in the payload for which the label update is intended."
        },
        {
          "info": {
            "name": "Update properties of an existing endpoint device based on the request body.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/endpoints/device/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "Endpoint User ID"
              },
              {
                "name": "objectDetails",
                "value": "",
                "type": "query",
                "description": "Set to true to return the updated object in the response body, otherwise the response body will only return the updated object ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "**Request:**\r\n            \r\nOnly the property to be updated can be passed in the request body instead of the whole object. The update request body requires a total of three keys to be filled with appropriate value as listed below:\r\n* **value** – The value property provides the new value.\r\n            \r\n* **path** – The path property indicates the element to update. The entire path with slashes needs to be provided here. Example: /status/id\r\n            \r\n* **op** – The op property indicates the "
        }
      ]
    }
  ],
  "bundled": true
}