{
    "restSchemaVersion": "1.0",
    "errors": [
      {
        "error_id": "BAD_REQUEST",
        "description": "Invalid argument.",
        "http_status": "400"
      },
      {
        "error_id": "AUTH_REQUIRED",
        "description": "Authentication required.",
        "http_status": "401"
      },
      {
        "error_id": "AUTH_INVALID_CREDENTIALS",
        "description": "Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.",
        "http_status": "401"
      },
      {
        "error_id": "HTTP_INVALID_METHOD",
        "description": "Requested method is not available for this resource.",
        "http_status": "405"
      },
      {
        "error_id": "INTERNAL_ERROR",
        "description": "Internal error.",
        "http_status": "500"
      }
    ],
    "name": "mgmt.global_snmp",
    "title": "Global SNMP API.",
    "version": "1.0",
    "schemas": [],
    "defaultAuthorization": "required",
    "servicePath": "/api/mgmt.global_snmp/1.0",
    "resources": {
      "Settings": {
        "methods": {
          "Display Settings": {
            "description": "Displays all Global SNMP settings.",
            "formats": [
              "json"
            ],
            "httpmethod": "GET",
            "path": "global_snmp",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "description":"Object with Polling Settings and Default Credentials.",
                "id":"Settings",
                "type": "object",
                "properties": {
                    "polling_settings": {
                    "type": "object",
                    "description":"Polling settings",
                    "properties": {
                        "polling_freq": {
                        "type": "number"
                        },
                        "refresh_freq": {
                        "type": "number"
                        }
                    },
                    "required": [
                        "polling_freq",
                        "refresh_freq"
                    ]
                    },
                    "default_credentials": {
                        "type": "array",
                        "description":"List of default credentials",
                        "items": {
                            "type": "object",
                            "properties": {
                                "id": {
                                "type": "number"
                                },
                                "version": {
                                "type": "string",
                                "description":"SNMP version, allowed ('v1','v2c','v3')"
                                },
                                "sec_level": {
                                "type": "string",
                                "description":"Security level for SNMP V3, allowed values('no_auth/no_priv','auth/no_priv','auth/priv')"
                                },
                                "username": {
                                "type": "string",
                                "description":"username, required for SNMP V3 only"
                                },
                                "auth_proto": {
                                "type": "string",
                                "description": "Authentication Protocol, only applicable for SNMP V3"
                                },
                                "auth_psswd": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "auth_psswd_key": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "auth_psswd_key_local": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "priv_proto": {
                                "type": "string",
                                "description": "Privacy Protocol, only applicable for SNMP V3"
                                },
                                "priv_psswd": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "priv_psswd_key": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "priv_psswd_key_local": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "user_label": {
                                "description":"User label for credential",
                                "type": "string"
                                },
                                "community": {
                                "description":"Community string, ignore if SNMP version 3",
                                  "type": "string"
                                }
                            },
                            "required": [
                                "version",
                                "username",
                                "community",
                                "auth_proto",
                                "auth_psswd",
                                "auth_psswd_key",
                                "auth_psswd_key_local",
                                "priv_proto",
                                "priv_psswd",
                                "priv_psswd_key",
                                "priv_psswd_key_local",
                                "user_label"
                            ]
                          }
                    }
                },
                "required": [
                  "polling_settings",
                  "default_credentials"
                ],
                "example":{
                    "polling_settings": {
                        "polling_freq": "0",
                        "refresh_freq": "0"
                    },
                    "default_credentials": [
                        {
                            "id": 1,
                            "version": "v1",
                            "community": "********",
                            "user_label": "first"
                        },
                        {
                            "id": 2,
                            "version": "v2c",
                            "community": "********",
                            "user_label": "second"
                        }
                    ]
                }
            },
            "authorization": "required"
          },
          "Configure Settings": {
            "description": "Configure all Global SNMP settings.",
            "formats": [
              "json"
            ],
            "httpmethod": "POST",
            "path": "global_snmp",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "request": {
                "description":"Object with Polling Settings and Default Credentials.",
                "id":"Settings",
                "type": "object",
                "properties": {
                    "polling_settings": {
                    "type": "object",
                    "description":"Polling settings",
                    "properties": {
                        "polling_freq": {
                        "type": "number"
                        },
                        "refresh_freq": {
                        "type": "number"
                        }
                    },
                    "required": [
                        "polling_freq",
                        "refresh_freq"
                    ]
                    },
                    "default_credentials": {
                        "type": "array",
                        "description":"List of default credentials",
                        "items": {
                            "type": "object",
                            "properties": {
                                "id": {
                                "type": "number"
                                },
                                "version": {
                                "type": "string",
                                "description":"SNMP version, allowed ('v1','v2c','v3')"
                                },
                                "sec_level": {
                                "type": "string",
                                "description":"Security level for SNMP V3, allowed values('no_auth/no_priv','auth/no_priv','auth/priv')"
                                },
                                "username": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "auth_proto": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "auth_psswd": {
                                  "type": "string",
                                  "description": "Only applicable for SNMP V3"
                                },
                                "auth_psswd_key": {
                                  "type": "string",
                                  "description": "Only applicable for SNMP V3"
                                },
                                "auth_psswd_key_local": {
                                  "type": "string",
                                  "description": "Only applicable for SNMP V3"
                                },
                                "priv_proto": {
                                "type": "string",
                                "description": "Only applicable for SNMP V3"
                                },
                                "priv_psswd": {
                                  "type": "string",
                                  "description": "Only applicable for SNMP V3"
                                },
                                "priv_psswd_key": {
                                  "type": "string",
                                  "description": "Only applicable for SNMP V3"
                                },
                                "priv_psswd_key_local": {
                                  "type": "string",
                                  "description": "Only applicable for SNMP V3"
                                },
                                "user_label": {
                                "description":"User label for credential",
                                "type": "string"
                                },
                                "community": {
                                "description":"Community string, ignore if SNMP version 3",
                                  "type": "string"
                                }
                            },
                            "required": [
                                "version",
                                "username",
                                "community",
                                "auth_proto",
                                "auth_psswd",
                                "auth_psswd_key",
                                "auth_psswd_key_local",
                                "priv_proto",
                                "priv_psswd",
                                "priv_psswd_key",
                                "priv_psswd_key_local",
                                "user_label"
                            ]
                        }
                    }
                },
                "required": [
                  "polling_settings",
                  "default_credentials"
                ],
                "example":{
                    "polling_settings": {
                        "polling_freq": "0",
                        "refresh_freq": "0"
                    },
                    "default_credentials": [
                        {
                            "id": 1,
                            "version": "v1",
                            "community": "********",
                            "user_label": "first"
                        },
                        {
                            "id": 2,
                            "version": "v2c",
                            "community": "********",
                            "user_label": "second"
                        }
                    ]
                }
            },
            "authorization": "required"
          },
          "Display Polling Settings":{
            "description": "Displays Polling settings.",
            "formats": [
              "json"
            ],
            "httpmethod": "GET",
            "path": "global_snmp/polling",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "description":"Object with Polling Settings",
                "type":"object",
                "id":"PollingSettings",
                "properties": {
                    "polling_freq": {
                      "type": "number"
                    },
                    "refresh_freq": {
                      "type": "number"
                    }
                },
                "required": [
                "polling_freq",
                "refresh_freq"
                ]
            },
            "authorization": "required"
          },
          "Configure Polling Settings":{
            "description": "Condigure Polling settings.",
            "formats": [
              "json"
            ],
            "httpmethod": "POST",
            "path": "global_snmp/polling",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "description":"Object with Polling Settings",
                "type":"object",
                "id":"PollingSettings",
                "properties": {
                    "polling_freq": {
                      "type": "number"
                    },
                    "refresh_freq": {
                      "type": "number"
                    }
                },
                "required": [
                "polling_freq",
                "refresh_freq"
                ]
            },
            "authorization": "required"
          },
          "Display Default Credentials":{
            "description": "Displays Default Credentials.",
            "formats": [
              "json"
            ],
            "httpmethod": "GET",
            "path": "global_snmp/default_credentials",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "type": "array",
                "id": "DefaultCredentials",
                "description":"List of default credentials",
                "items": 
                {
                    "type": "object",
                    "properties": {
                        "id": {
                        "type": "number"
                        },
                        "version": {
                        "type": "string",
                        "description":"SNMP version, allowed ('v1','v2c','v3')"
                        },
                        "sec_level": {
                        "type": "string",
                        "description":"Security level for SNMP V3, allowed values('no_auth/no_priv','auth/no_priv','auth/priv')"
                        },
                        "username": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_proto": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_psswd": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_psswd_key": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_psswd_key_local": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_proto": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_psswd": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_psswd_key": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_psswd_key_local": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "user_label": {
                        "type": "string"
                        }
                    },
                    "required": [
                        "version",
                        "sec_level",
                        "username",
                        "auth_proto",
                        "auth_psswd",
                        "auth_psswd_key",
                        "auth_psswd_key_local",
                        "priv_proto",
                        "priv_psswd",
                        "priv_psswd_key",
                        "priv_psswd_key_local",
                        "user_label"
                    ]
                }
              
            },
            "authorization": "required"
          },
          "Configure Default Credentials":{
            "description": "Configure Default Credentials.",
            "formats": [
              "json"
            ],
            "httpmethod": "POST",
            "path": "global_snmp/default_credentials",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "type": "array",
                "id": "DefaultCredentials",
                "description":"List of default credentials",
                "items": 
                {
                    "type": "object",
                    "description":"Credential details",
                    "properties": {
                        "id": {
                        "type": "number"
                        },
                        "version": {
                        "type": "string",
                        "description":"SNMP version, allowed ('v1','v2c','v3')"
                        },
                        "sec_level": {
                        "type": "string",
                        "description":"Security level for SNMP V3, allowed values('no_auth/no_priv','auth/no_priv','auth/priv')"
                        },
                        "username": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_proto": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_psswd": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_psswd_key": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "auth_psswd_key_local": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_proto": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_psswd": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_psswd_key": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "priv_psswd_key_local": {
                        "type": "string",
                        "description": "Only applicable for SNMP V3"
                        },
                        "user_label": {
                        "type": "string"
                        }
                    },
                    "required": [
                        "version",
                        "sec_level",
                        "username",
                        "auth_proto",
                        "auth_psswd",
                        "auth_psswd_key",
                        "auth_psswd_key_local",
                        "priv_proto",
                        "priv_psswd",
                        "priv_psswd_key",
                        "priv_psswd_key_local",
                        "user_label"
                    ]
                }
            },
            "authorization": "required"
          },
          "Display Default Credentials by ID":{
            "description": "Displays Default Credential by Id.",
            "formats": [
              "json"
            ],
            "httpmethod": "GET",
            "path": "global_snmp/default_credentials/<id>",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "type": "object",
                "description":"Object of Default Credential",
                "properties": {
                    "id": {
                    "type": "number"
                    },
                    "version": {
                    "type": "string",
                    "description":"SNMP version, allowed ('v1','v2c','v3')"
                    },
                    "sec_level": {
                    "type": "string",
                    "description":"Security level for SNMP V3, allowed values('no_auth/no_priv','auth/no_priv','auth/priv')"
                    },
                    "username": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_proto": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd_key": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd_key_local": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_proto": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd_key": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd_key_local": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "user_label": {
                    "type": "string"
                    }
                },
                "required": [
                    "version",
                    "sec_level",
                    "username",
                    "auth_proto",
                    "auth_psswd",
                    "auth_psswd_key",
                    "auth_psswd_key_local",
                    "priv_proto",
                    "priv_psswd",
                    "priv_psswd_key",
                    "priv_psswd_key_local",
                    "user_label"
                ]
            },
            "authorization": "required"
          },
          "Configure Default Credentials by ID":{
            "description": "Configure Default Credentials.",
            "formats": [
              "json"
            ],
            "httpmethod": "POST",
            "path": "global_snmp/default_credentials/<id>",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "type": "object",
                "description":"Object of Default Credential",
                "properties": {
                    "id": {
                    "type": "number"
                    },
                    "version": {
                    "type": "string",
                    "description":"SNMP version, allowed ('v1','v2c','v3')"
                    },
                    "sec_level": {
                    "type": "string",
                    "description":"Security level for SNMP V3, allowed values('no_auth/no_priv','auth/no_priv','auth/priv')"
                    },
                    "username": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_proto": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd_key": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd_key_local": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_proto": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd_key": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd_key_local": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "user_label": {
                    "type": "string"
                    }
                },
                "required": [
                    "version",
                    "sec_level",
                    "username",
                    "auth_proto",
                    "auth_psswd",
                    "auth_psswd_key",
                    "auth_psswd_key_local",
                    "priv_proto",
                    "priv_psswd",
                    "priv_psswd_key",
                    "priv_psswd_key_local",
                    "user_label"
                ]
            },
            "authorization": "required"
          },
          "Delete Default Credentials by ID":{
            "description": "Configure Default Credentials.",
            "formats": [
              "json"
            ],
            "httpmethod": "DELETE",
            "path": "global_snmp/default_credentials/<id>",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
                "type": "object",
                "description":"Object of Default Credential",
                "properties": {
                    "id": {
                    "type": "number"
                    },
                    "version": {
                    "type": "string",
                    "description":"SNMP version, allowed ('v1','v2c','v3')"
                    },
                    "sec_level": {
                    "type": "string",
                    "description":"Security level for SNMP V3, allowed values('no_auth/no_priv','auth/no_priv','auth/priv')"
                    },
                    "username": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_proto": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd_key": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "auth_psswd_key_local": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_proto": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd_key": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "priv_psswd_key_local": {
                    "type": "string",
                    "description": "Only applicable for SNMP V3"
                    },
                    "user_label": {
                    "type": "string"
                    }
                },
                "required": [
                    "version",
                    "sec_level",
                    "username",
                    "auth_proto",
                    "auth_psswd",
                    "auth_psswd_key",
                    "auth_psswd_key_local",
                    "priv_proto",
                    "priv_psswd",
                    "priv_psswd_key",
                    "priv_psswd_key_local",
                    "user_label"
                ]
            },
            "authorization": "required"
          }
        }
      }
  },
    "description": "<h2>Overview</h2>\n\n<p>\nThe documentation pages in this section describe\nthe RESTful APIs included with Riverbed SteelCentral Product. It is assumed \nthat the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on what\ndata can be accessed, how to configure and clear it.\n</p>\n\n<p>\nThe following operations can be performed via the API:\n</p>\n<ul>\n <li>Display Global SNMP settings</li> \n <li>Configure Global SNMP settings</li> \n <li>Display Polling settings</li>\n <li>Configure Polling settings</li> \n <li>Display Default Credentials settings</li> \n  <li>Configure Default Credentials settings</li> \n  <li>Display Default Credentials by ID</li> \n <li>Configure Default Credentials by ID</li> \n <li>Delete Default Credentials by ID</li> \n </ul>\n\n<p>\nDetails about REST resources can be found in the <b>Resources</b>\nsection. This overview continues with how to run these API's.\n</p>\n\n<h2>Authentication</h2>\n\n<p>\nAll REST requests must be authenticated. The <b>Authentication</b>\nsection of the Common API describes which authentication methods\nare presently supported. \n</p>\n\n"
}