Shodan

Shodan Notifiers API

Manage notification providers used by alerts.

Documentation GitHub OpenAPI

Documentation

https://developer.shodan.io/api

https://developer.shodan.io/api

https://developer.shodan.io/api/requirements

https://developer.shodan.io/api/stream

https://developer.shodan.io/api/stream

https://developer.shodan.io/api/trends

https://developer.shodan.io/api/trends

https://internetdb.shodan.io/

https://cvedb.shodan.io/

Specifications

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/openapi/shodan-notifiers-api-openapi.yml

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/asyncapi/shodan-stream-asyncapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-host-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-search-result-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-alert-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-notifier-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-rest-scan-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-structure/shodan-rest-host-structure.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-structure/shodan-rest-alert-structure.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-stream-banner-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-structure/shodan-stream-banner-structure.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-trends-result-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-internetdb-host-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-cvedb-cve-schema.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-schema/shodan-cvedb-cpe-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/json-ld/shodan-context.jsonld

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-host-lookup-example.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-search-example.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-scan-create-example.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-rest-alert-create-example.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-stream-banner-example.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-trends-search-example.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-internetdb-host-example.json

https://raw.githubusercontent.com/api-evangelist/shodan/refs/heads/main/examples/shodan-cvedb-cve-lookup-example.json

OpenAPI Specification

openapi: 3.1.0
info:
  title: Shodan CVEDB Account Notifiers API
  description: Shodan's CVEDB is a free vulnerability database API that supports CVE lookups, CPE-keyed vulnerability search, KEV filtering, EPSS ordering, date-range queries, and product-name search. No API key required; updated daily.
  version: '1.0'
  contact:
    name: Shodan Support
    email: support@shodan.io
    url: https://cvedb.shodan.io/
  license:
    name: Shodan API Terms of Service
    url: https://www.shodan.io/legal/tos
servers:
- url: https://cvedb.shodan.io
  description: Production
tags:
- name: Notifiers
  description: Manage notification providers used by alerts.
paths:
  /notifier:
    get:
      tags:
      - Notifiers
      summary: List Notifiers
      operationId: listNotifiers
      description: Returns the list of notifiers the user has configured.
      responses:
        '200':
          description: Notifier list.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Notifier'
    post:
      tags:
      - Notifiers
      summary: Create Notifier
      operationId: createNotifier
      description: Create a new notifier for receiving alerts.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotifierCreate'
      responses:
        '200':
          description: Created notifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notifier'
  /notifier/provider:
    get:
      tags:
      - Notifiers
      summary: List Notifier Providers
      operationId: listNotifierProviders
      description: Returns the list of available notification provider types.
      responses:
        '200':
          description: Provider catalog.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
  /notifier/{id}:
    get:
      tags:
      - Notifiers
      summary: Get Notifier
      operationId: getNotifier
      description: Returns information about a specific notifier.
      parameters:
      - $ref: '#/components/parameters/NotifierId'
      responses:
        '200':
          description: Notifier details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notifier'
    put:
      tags:
      - Notifiers
      summary: Update Notifier
      operationId: updateNotifier
      description: Update an existing notifier configuration.
      parameters:
      - $ref: '#/components/parameters/NotifierId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotifierCreate'
      responses:
        '200':
          description: Updated notifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notifier'
    delete:
      tags:
      - Notifiers
      summary: Delete Notifier
      operationId: deleteNotifier
      description: Delete a notifier.
      parameters:
      - $ref: '#/components/parameters/NotifierId'
      responses:
        '200':
          description: Notifier deletion result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
components:
  parameters:
    NotifierId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: Notifier identifier.
  schemas:
    Notifier:
      type: object
      properties:
        id:
          type: string
        provider:
          type: string
        description:
          type: string
        args:
          type: object
          additionalProperties: true
    NotifierCreate:
      type: object
      required:
      - provider
      - description
      - args
      properties:
        provider:
          type: string
        description:
          type: string
        args:
          type: object
          additionalProperties: true