Platform

    Get real-time insights and automation for comprehensive, seamless monitoring with agentless architecture.

    Platform Overview
  • Infrastructure
    monitoring
  • Cloud monitoring
  • Digital experience
  • AIOPS

      • Solutions

      Whether you work in MSP, Enterprise IT or somewhere in between, the solution is clear.

      Solutions Overview
    By Initiative
    By Industry

      About us

      Get to know LogicMonitor and our team.

      About us
    Get to know us
    Connect
    Services

      Documentation

      Read through our documentation, check out our latest release notes, or submit a ticket to our world-class customer service team.

      View Resources
    Support

    Product Documentation

    Get SiteMonitor Checkpoints

    Last updated on 25 November, 2020

    The SiteMonitor (SM) Checkpoint resource allows you to programmatically get information about SiteMonitor Checkpoints.

    Using LogicMonitor’s REST API, you can:

    • Get a list of SiteMonitor Checkpoints
    • Get information about a particular SiteMonitor Checkpoint

    Note: As with all of our API calls, authentication is required.

    Resource URI

    /service/smcheckpoints

    Resource Properties

    All SiteMonitor checkpoints have the following properties:

    Property

    Description

    Type
    id The Id of the SiteMonitor Checkpoint Integer
    name The name of the SiteMonitor Checkpoint String
    geoinfo The geographical information (location) of the SiteMonitor Checkpoint String
    description The description of the SiteMonitor Checkpoint String
    displayPrio The display priority of the SiteMonitor Checkpoint in your LogicMonitor portal Integer

    Get a list of checkpoints

    Returns a list of SiteMonitor Checkpoints

    HTTP Method:GET

    URI: /service/smcheckpoints

    Request Parameters:By default, all SM checkpoints will be returned. You can include sort, filter,  fields, size, and offset parameters that control what data is included in the response and how it is formatted. Note that query parameters are not considered part of the resource path, and should not be included the calculation of the LMv1 authentication signature.

    Property

    Syntax

    Description

    Example URI
    sort sort={+ or -}property Sorts the response by the property specified in either increasing (+) or decreasing (-) order /service/smcheckpoints?sort=-id
    filter filter=property:value Filters the response to include only the results that have the specified value for the specified property /service/smcheckpoints?filter=name:QAservice
    fields fields=list of properties separated by commas Filters the response to only include the following fields for each object /service/smcheckpoints?fields=name,id
    size size=integer The number of results to display /service/smcheckpoints?size=5
    offset offset=integer The number of results to offset the displayed results by /service/smcheckpoints?offset=2

    Example 1: Get a list of all SM checkpoints

    The following request returns a list of all SiteMonitor checkpoints:

    Request:

    curl -v --user 'apiUser:example' -X GET "https://api.logicmonitor.com/santaba/rest/service/smcheckpoints"

    Response:

    {
  "status" : 200,
  "errmsg" : "OK",
  "data" : {
    "total" : 4,
    "items" : [ {
      "id" : 1,
      "name" : "US - Washington DC",
      "geoInfo" : "US - Washington DC",
      "description" : "This is DC7 group",
      "displayPrio" : 50
    }, {
      "id" : 2,
      "name" : "US - San Francisco",
      "geoInfo" : "US - San Francisco",
      "description" : "US - San Francisco",
      "displayPrio" : 40
    }, {
      "id" : 3,
      "name" : "Europe - Dublin",
      "geoInfo" : "Europe - Dublin",
      "description" : "Europe - Dublin",
      "displayPrio" : 20
    }, {
      "id" : 4,
      "name" : "Asia - Singapore",
      "geoInfo" : "Asia - Singapore",
      "description" : "Asia - Singapore",
      "displayPrio" : 10
    } ],
    "searchId" : null
  }

    Example 2: Get information about one SiteMonitor checkpoint

    The following request returns information about the SiteMonitor checkpoint with id 5:

    Request:

    curl -v --user 'apiUser:example' -X GET "https://api.logicmonitor.com/santaba/rest/service/smcheckpoints/5"

    Response:

    {
  "status" : 200,
  "errmsg" : "OK",
  "data" : {
    "id" : 5,
    "name" : "Asia - Singapore",
    "geoInfo" : "Asia - Singapore",
    "description" : "Asia - Singapore",
    "displayPrio" : 10
  }
    In This Article