Config - Contacts

Object type: contact

Request URL: /rest/config/contact

Methods:

Listing Contacts Copied

Example GET and response Copied 

$ opsview_rest --username=admin --password=initial --pretty GET 'config/contact?s.name=admin'
{
  list => [
    {
      description                => "System Administrator",
      enable_tips                => 0,
      fullname                   => "Administrator",
      homepage_id                => 2,
      id                         => 1,
      language                   => "",
      mylinks                    => [ ],
      name                       => "admin",
      notificationprofiles       => [ ],
      realm                      => "local",
      ref                        => "/rest/config/contact/1",
      role                       => { name => "Administrator", ref => "/rest/config/role/10" },
      sharednotificationprofiles => [ ],
      uncommitted                => 0,
      variables                  => [
                                      { name => "RSS_COLLAPSED", value => 1 },
                                      { name => "RSS_MAXIMUM_AGE", value => 1440 },
                                      { name => "RSS_MAXIMUM_ITEMS", value => 30 },
                                    ],
    },
  ],
  summary => { allrows => 4, page => 1, rows => 1, totalpages => 1, totalrows => 1 },
}

Creating Contacts Copied

Example POST Copied 

$ opsview_rest --username=admin --password=initial --content-file=newcontact.json POST 'config/contact

Contents of file newcontact.json:

{
  "language": "",
  "homepage_id": null,
  "name": "newuser",
  "variables": [],
  "description": "",
  "sharednotificationprofiles": [],
  "notificationprofiles": [],
  "mylinks": [],
  "fullname": "New User",
  "realm": "local",
  "role": {
    "ref": "/rest/config/role/10",
    "name": "Administrator"
  },
  "enable_tips": "1",
  "uncommitted": "0"
}

Updating Contacts Copied

Example PUT Copied 

$ opsview_rest --username=admin --password=initial PUT 'config/contact '{"name":"newuser", "fullname":"John Smith"}'
["Opsview On-premises"] ["API", "Technical Reference"]

Was this topic helpful?