Snmp | Nodeum Docs

Return list of traps

get

API Key Scope: traps / index

Authorizations

Responses

200

List of trap.

application/json

get

/snmp/traps

GET /api/v2/snmp/traps HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of trap.

{
  "count": 1,
  "traps": [
    {
      "snmp_trap_id": "text",
      "activation": 1,
      "version": "text",
      "manager": "text",
      "community": "text",
      "severity_low": 1,
      "severity_high": 1
    }
  ]
}

Creates a new trap.

post

API Key Scope: traps / create

Authorizations

Body

snmp_trap_idstringOptional

activationintegerOptional

versionstringOptional

managerstringOptional

communitystringOptional

severity_lowintegerOptional

severity_highintegerOptional

Responses

201

A specific trap.

application/json

422

The received resource was not correctly formatted.

application/json

post

/snmp/traps

POST /api/v2/snmp/traps HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "snmp_trap_id": "text",
  "activation": 1,
  "version": "text",
  "manager": "text",
  "community": "text",
  "severity_low": 1,
  "severity_high": 1
}

{
  "snmp_trap_id": "text",
  "activation": 1,
  "version": "text",
  "manager": "text",
  "community": "text",
  "severity_low": 1,
  "severity_high": 1
}

Displays a specific trap.

get

API Key Scope: traps / show

Authorizations

Path parameters

snmp_trap_idstringRequired

Numeric ID of snmp trap.

Responses

200

A specific trap.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/snmp/traps/{snmp_trap_id}

GET /api/v2/snmp/traps/{snmp_trap_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "snmp_trap_id": "text",
  "activation": 1,
  "version": "text",
  "manager": "text",
  "community": "text",
  "severity_low": 1,
  "severity_high": 1
}

Updates a specific trap with his relations.

put

API Key Scope: traps / update

Authorizations

Path parameters

snmp_trap_idstringRequired

Numeric ID of snmp trap.

Body

snmp_trap_idstringOptional

activationintegerOptional

versionstringOptional

managerstringOptional

communitystringOptional

severity_lowintegerOptional

severity_highintegerOptional

Responses

200

A specific trap.

application/json

422

The received resource was not correctly formatted.

application/json

put

/snmp/traps/{snmp_trap_id}

PUT /api/v2/snmp/traps/{snmp_trap_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "snmp_trap_id": "text",
  "activation": 1,
  "version": "text",
  "manager": "text",
  "community": "text",
  "severity_low": 1,
  "severity_high": 1
}

{
  "snmp_trap_id": "text",
  "activation": 1,
  "version": "text",
  "manager": "text",
  "community": "text",
  "severity_low": 1,
  "severity_high": 1
}

Destroys a specific trap.

delete

API Key Scope: traps / destroy

Authorizations

Path parameters

snmp_trap_idstringRequired

Numeric ID of snmp trap.

Responses

204

trap destroyed.

No content

delete

/snmp/traps/{snmp_trap_id}

DELETE /api/v2/snmp/traps/{snmp_trap_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

trap destroyed.

No content

Return server configuration infos

get

API Key Scope: server_configuration / show

Authorizations

Responses

200

server configuration infos.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/snmp/server_configuration

GET /api/v2/snmp/server_configuration HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "version": "text",
  "community": "text",
  "location": "text",
  "contact": "text"
}

Updates server configuration infos.

put

API Key Scope: server_configuration / update

Authorizations

Body

versionstringOptional

communitystringOptional

locationstringOptional

contactstringOptional

Responses

200

server configuration infos.

application/json

422

The received resource was not correctly formatted.

application/json

put

/snmp/server_configuration

PUT /api/v2/snmp/server_configuration HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "version": "text",
  "community": "text",
  "location": "text",
  "contact": "text"
}

{
  "version": "text",
  "community": "text",
  "location": "text",
  "contact": "text"
}