NPM SSL Module APIs v1.0
Created Dec 18, 2020 at 07:09 PM

Resource: ignored_certificate

This resource deals with an ignored certificate

http://{device}/api/npm.ssl_module/1.0/ignored_certificates/items/{id}
  • JSON
  • {
      "id": string
    }
    Property Name Type Description Notes
    ignored_certificate <object> This resource deals with an ignored certificate
    ignored_certificate.id <string> A unique id for the certificate Optional;

    Resource: ignored_certificates

    This resource deals with ignored certificates

    http://{device}/api/npm.ssl_module/1.0/ignored_certificates
  • JSON
  • {
      "items": [ ignored_certificate ],
      "limit": ignored_certs_limit,
      <prop>: any
    }
    Property Name Type Description Notes
    ignored_certificates <object> This resource deals with ignored certificates
    ignored_certificates.items <array of <ignored_certificate>> Optional;
    ignored_certificates.items[items] <ignored_certificate> This resource deals with an ignored certificate
    ignored_certificates.limit <ignored_certs_limit>
    ignored_certificates.<prop> <any> Optional;

    Resource: latest_certificate

    This resource deals with a certificate

    http://{device}/api/npm.ssl_module/1.0/latest_certificates/items/{id}
  • JSON
  • {
      "first_seen": string,
      "has_rsa_key": boolean,
      "id": string,
      "ignored": boolean,
      "issuer": {
        "common_name": string,
        "country": string,
        "organization": string,
        <prop>: any
      },
      "last_seen": string,
      "serial_number": string,
      "servers": [
        {
          "host": string,
          "port": integer,
          <prop>: any
        }
      ],
      "status": string,
      "subject": {
        "common_name": string,
        "country": string,
        "locality": string,
        "organization": string,
        "organization_unit": string,
        "state": string,
        <prop>: any
      },
      "valid_from": string,
      "valid_to": string
    }
    Property Name Type Description Notes
    latest_certificate <object> This resource deals with a certificate
    latest_certificate.first_seen <string> Time at which this certificate was first seen Optional;
    latest_certificate.has_rsa_key <boolean> True if the certificate is expired Optional;
    latest_certificate.id <string> A unique id for the certificate Optional;
    latest_certificate.ignored <boolean> True if the certificate is ignored Optional;
    latest_certificate.issuer <object> Certificate 'Issuer' details Optional;
    latest_certificate.issuer.common_name <string> 'Issuer' common name Optional;
    latest_certificate.issuer.country <string> 'Issuer' country Optional;
    latest_certificate.issuer.organization <string> 'Issuer' organization Optional;
    latest_certificate.issuer.<prop> <any> Optional;
    latest_certificate.last_seen <string> Time at which this certificate was last seen Optional;
    latest_certificate.serial_number <string> Certificate 'Serial Number' Optional;
    latest_certificate.servers <array of <object>> Optional;
    latest_certificate.servers[items] <object> Certificate server endpoint
    latest_certificate.servers[items].host <string> The IP address of the server Optional;
    latest_certificate.servers[items].port <integer> The TCP port of the server Optional;
    latest_certificate.servers[items].<prop> <any> Optional;
    latest_certificate.status <string> Certificate current status (Valid, Invalid, Expired, Revoked) Optional;
    latest_certificate.subject <object> Certificate 'Subject' details Optional;
    latest_certificate.subject.common_name <string> 'Subject' common name Optional;
    latest_certificate.subject.country <string> 'Subject' country Optional;
    latest_certificate.subject.locality <string> 'Subject' locality Optional;
    latest_certificate.subject.organization <string> 'Subject' organization Optional;
    latest_certificate.subject.
    organization_unit
    <string> 'Subject' organization unit Optional;
    latest_certificate.subject.state <string> 'Subject' state Optional;
    latest_certificate.subject.<prop> <any> Optional;
    latest_certificate.valid_from <string> Certificate 'Not Before' Optional;
    latest_certificate.valid_to <string> Certificate 'Not After' Optional;

    Resource: latest_certificates

    This resource deals with the list of latest certificate processed

    http://{device}/api/npm.ssl_module/1.0/latest_certificates
  • JSON
  • {
      "items": [ latest_certificate ],
      "total": integer,
      <prop>: any
    }
    Property Name Type Description Notes
    latest_certificates <object> This resource deals with the list of latest certificate processed
    latest_certificates.items <array of <latest_certificate>> Optional;
    latest_certificates.items[items] <latest_certificate> This resource deals with a certificate
    latest_certificates.total <integer> The number of total requested certificates Optional;
    latest_certificates.<prop> <any> Optional;

    Resource: ssl_module

    This resource deals with SSL Module configuration

    http://{device}/api/npm.ssl_module/1.0/ssl_module
  • JSON
  • {
      "enabled": boolean
    }
    Property Name Type Description Notes
    ssl_module <object> This resource deals with SSL Module configuration Required properties: [enabled];
    ssl_module.enabled <boolean> Enable/disable SSL Module.

    Type: certs_bulk_deleter

  • JSON
  • {
      "delete_all": boolean,
      "delete_ids": [
        string
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    certs_bulk_deleter <object>
    certs_bulk_deleter.delete_all <boolean> Delete all objects in the given config Optional;
    certs_bulk_deleter.delete_ids <array of <string>> List of certificate ids to delete Optional;
    certs_bulk_deleter.delete_ids[items] <string>
    certs_bulk_deleter.<prop> <any> Optional;

    Type: ignored_certs_limit

  • JSON
  • {
      "current": integer,
      "max": integer,
      <prop>: any
    }
    Property Name Type Description Notes
    ignored_certs_limit <object>
    ignored_certs_limit.current <integer> The current number of certificates ignored Optional;
    ignored_certs_limit.max <integer> The max number of certificates that can be ignored Optional;
    ignored_certs_limit.<prop> <any> Optional;

    Type: latest_certs_bulk_deleter

  • JSON
  • {
      "delete_all": boolean,
      "delete_all_ignored": boolean,
      "delete_ids": [
        string
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    latest_certs_bulk_deleter <object>
    latest_certs_bulk_deleter.delete_all <boolean> Delete all objects in the given config Optional;
    latest_certs_bulk_deleter.
    delete_all_ignored
    <boolean> Delete all ignored certificates in the given config Optional;
    latest_certs_bulk_deleter.delete_ids <array of <string>> List of certificate ids to delete Optional;
    latest_certs_bulk_deleter.delete_ids
    [items]
    <string>
    latest_certs_bulk_deleter.<prop> <any> Optional;