NPM SSL Module APIs v1.1

Resource: approved_ciphers

SSL/TLS Module Approved Ciphers.

http://{device}/api/npm.ssl_module/1.1/approved_ciphers

JSON

{
  "cipher_list": string,
  "ciphers": [
    string
  ]
}

{
  "cipher_list": string,
  "ciphers": [
    string
  ]
}

Property Name	Type	Description	Notes
approved_ciphers	<object>	SSL/TLS Module Approved Ciphers.	Required properties: [cipher_list];
approved_ciphers.cipher_list	<string>	Approved cipher list (openssl format).
approved_ciphers.ciphers	<array of <string>>	List of ciphers defined by the "cipher_list" value.	Read-only; Optional;
approved_ciphers.ciphers[items]	<string>		Read-only;

Links

approved_ciphers: get

Returns the SSL/TLS Module approved ciphers list.

GET http://{device}/api/npm.ssl_module/1.1/approved_ciphers

Response Body

Returns an approved_ciphers data object.

approved_ciphers: set

Updates the SSL/TLS Module approved ciphers list.

PUT http://{device}/api/npm.ssl_module/1.1/approved_ciphers

Request Body

Provide an approved_ciphers data object.

Response Body

Returns an approved_ciphers data object.

Resource: approved_versions

SSL/TLS Module Approved Versions.

http://{device}/api/npm.ssl_module/1.1/approved_versions

JSON

{
  "items": [
    string
  ]
}

{
  "items": [
    string
  ]
}

Property Name	Type	Description	Notes
approved_versions	<object>	SSL/TLS Module Approved Versions.	Required properties: [items];
approved_versions.items	<array of <string>>
approved_versions.items[items]	<string>	TLS Version Identifier.	Values: SSL_v2, SSL_v3, TLS_1.0, TLS_1.1, TLS_1.2, TLS_1.3;

Links

approved_versions: get

Returns the SSL/TLS Module approved versions list.

GET http://{device}/api/npm.ssl_module/1.1/approved_versions

Response Body

Returns an approved_versions data object.

approved_versions: set

Updates the SSL/TLS Module approved versions list.

PUT http://{device}/api/npm.ssl_module/1.1/approved_versions

Request Body

Provide an approved_versions data object.

Response Body

Returns an approved_versions data object.

Resource: certificate_issuer

X509 certificate issuer

http://{device}/api/npm.ssl_module/1.1/certificate_issuers/items/{id}

JSON

{
  "id": integer,
  "name": string
}

{
  "id": integer,
  "name": string
}

Property Name	Type	Description	Notes
certificate_issuer	<object>	X509 certificate issuer	Required properties: [name];
certificate_issuer.id	<integer>	Certificate Issuer ID.	Read-only; Optional;
certificate_issuer.name	<string>	Common Name of the X509 Certificate Issuer.

Links

certificate_issuer: delete_approved

Deletes an approved certificate issuer.

DELETE http://{device}/api/npm.ssl_module/1.1/certificate_issuers/approved/items/{id}

Response Body

On success, the server does not provide any body in the responses.

certificate_issuer: delete_denied

Deletes a denied certificate issuer.

DELETE http://{device}/api/npm.ssl_module/1.1/certificate_issuers/denied/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Resource: certificate_issuers

SSL/TLS Module Certificate Issuers.

http://{device}/api/npm.ssl_module/1.1/certificate_issuers

JSON

{
  "approved_issuers": certificate_issuers_list,
  "denied_issuers": certificate_issuers_list,
  "mode": certificate_issuers_mode_t
}

{
  "approved_issuers": certificate_issuers_list,
  "denied_issuers": certificate_issuers_list,
  "mode": certificate_issuers_mode_t
}

Property Name	Type	Description	Notes
certificate_issuers	<object>	SSL/TLS Module Certificate Issuers.	Required properties: [mode, approved_issuers, denied_issuers];
certificate_issuers.approved_issuers	<certificate_issuers_list>	List of the certificate issuers.
certificate_issuers.denied_issuers	<certificate_issuers_list>	List of the certificate issuers.
certificate_issuers.mode	<certificate_issuers_mode_t>	X509 Certificates Mode.	Values: APPROVE, DENY;

Links

certificate_issuers: add_approved

Add a new certificate issuer to the approved list.

POST http://{device}/api/npm.ssl_module/1.1/certificate_issuers/approved

Request Body

Provide a certificate_issuer data object.

Response Body

Returns a certificate_issuer data object.

certificate_issuers: add_denied

Add a new certificate issuer to the denied list.

POST http://{device}/api/npm.ssl_module/1.1/certificate_issuers/denied

Request Body

Provide a certificate_issuer data object.

Response Body

Returns a certificate_issuer data object.

certificate_issuers: bulk_add_approved

Add one or more certificates issuer to the approved list.

POST http://{device}/api/npm.ssl_module/1.1/certificate_issuers/approved/bulk_add

Request Body

Provide a certificate_issuers_list data object.

Response Body

Returns a certificate_issuers_list data object.

certificate_issuers: bulk_add_denied

Add one or more certificates issuer to the denied list.

POST http://{device}/api/npm.ssl_module/1.1/certificate_issuers/denied/bulk_add

Request Body

Provide a certificate_issuers_list data object.

Response Body

Returns a certificate_issuers_list data object.

certificate_issuers: bulk_delete_approved

Deletes a list of approved certificate issuers.

POST http://{device}/api/npm.ssl_module/1.1/certificate_issuers/approved/bulk_delete

Request Body

Provide a certificate_issuers_bulk_deleter data object.

Response Body

Returns a certificate_issuers_bulk_deleter data object.

certificate_issuers: bulk_delete_denied

Deletes a list of denied certificate issuers.

POST http://{device}/api/npm.ssl_module/1.1/certificate_issuers/denied/bulk_delete

Request Body

Provide a certificate_issuers_bulk_deleter data object.

Response Body

Returns a certificate_issuers_bulk_deleter data object.

certificate_issuers: get

Returns the SSL/TLS Module approved and denied certificate issuers lists.

GET http://{device}/api/npm.ssl_module/1.1/certificate_issuers

Response Body

Returns a certificate_issuers data object.

certificate_issuers: get_approved

Returns the SSL/TLS Module approved certificate issuers lists.

GET http://{device}/api/npm.ssl_module/1.1/certificate_issuers/approved

Response Body

Returns a certificate_issuers_list data object.

certificate_issuers: get_denied

Returns the SSL/TLS Module denied certificate issuers lists.

GET http://{device}/api/npm.ssl_module/1.1/certificate_issuers/denied

Response Body

Returns a certificate_issuers_list data object.

certificate_issuers: get_mode

Returns the SSL/TLS Module certificate issuers mode.

GET http://{device}/api/npm.ssl_module/1.1/certificate_issuers/mode

Response Body

Returns a certificate_issuers_mode data object.

certificate_issuers: set_mode

Sets the SSL/TLS Module certificate issuers mode.

PUT http://{device}/api/npm.ssl_module/1.1/certificate_issuers/mode

Request Body

Provide a certificate_issuers_mode data object.

Response Body

Returns a certificate_issuers_mode data object.

Resource: ignored_certificate

Ignored certificate.

http://{device}/api/npm.ssl_module/1.1/ignored_certificates/items/{id}

JSON

{
  "id": string
}

{
  "id": string
}

Property Name	Type	Description	Notes
ignored_certificate	<object>	Ignored certificate.
ignored_certificate.id	<string>	A unique id for the certificate.	Optional;

Links

ignored_certificate: delete

Un-ignores a certificate.

DELETE http://{device}/api/npm.ssl_module/1.1/ignored_certificates/items/{id}

Response Body

On success, the server does not provide any body in the responses.

ignored_certificate: get

Returns an ignored certificate ID.

GET http://{device}/api/npm.ssl_module/1.1/ignored_certificates/items/{id}

Response Body

Returns an ignored_certificate data object.

Resource: ignored_certificates

Ignored certificates.

http://{device}/api/npm.ssl_module/1.1/ignored_certificates

JSON

{
  "items": [ ignored_certificate ],
  "limit": ignored_certs_limit,
  <prop>: any
}

{
  "items": [ ignored_certificate ],
  "limit": ignored_certs_limit,
  <prop>: any
}

Property Name	Type	Description	Notes
ignored_certificates	<object>	Ignored certificates.
ignored_certificates.items	<array of <ignored_certificate>>		Optional;
ignored_certificates.items[items]	<ignored_certificate>	Ignored certificate.
ignored_certificates.limit	<ignored_certs_limit>
ignored_certificates.<prop>	<any>		Optional;

Links

ignored_certificates: bulk_create

Ignores a list of certificates.

POST http://{device}/api/npm.ssl_module/1.1/ignored_certificates/bulk_create

Request Body

Provide an ignored_certificates data object.

Response Body

Returns an ignored_certificates data object.

ignored_certificates: bulk_delete

Un-ignores a list of certificates.

POST http://{device}/api/npm.ssl_module/1.1/ignored_certificates/bulk_delete

Request Body

Provide a certs_bulk_deleter data object.

Response Body

Returns a certs_bulk_deleter data object.

ignored_certificates: create

Ignores a certificate.

POST http://{device}/api/npm.ssl_module/1.1/ignored_certificates

Request Body

Provide an ignored_certificate data object.

Response Body

Returns an ignored_certificate data object.

ignored_certificates: get

Returns the list of ignored certificate IDs.

GET http://{device}/api/npm.ssl_module/1.1/ignored_certificates

Response Body

Returns an ignored_certificates data object.

ignored_certificates: limit

Returns the ignored certificates entries limit.

GET http://{device}/api/npm.ssl_module/1.1/ignored_certificates/limit

Response Body

Returns an ignored_certs_limit data object.

Resource: latest_certificate

Processed certificate.

http://{device}/api/npm.ssl_module/1.1/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
}

{
  "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>	Processed 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;

Links

latest_certificate: delete

Deletes a certificate.

DELETE http://{device}/api/npm.ssl_module/1.1/latest_certificates/items/{id}

Response Body

On success, the server does not provide any body in the responses.

latest_certificate: get

Returns a certificate.

GET http://{device}/api/npm.ssl_module/1.1/latest_certificates/items/{id}

Response Body

Returns a latest_certificate data object.

Resource: latest_certificates

Processed certificates.

http://{device}/api/npm.ssl_module/1.1/latest_certificates

JSON

{
  "items": [ latest_certificate ],
  "total": integer,
  <prop>: any
}

{
  "items": [ latest_certificate ],
  "total": integer,
  <prop>: any
}

Property Name	Type	Description	Notes
latest_certificates	<object>	Processed certificates.
latest_certificates.items	<array of <latest_certificate>>		Optional;
latest_certificates.items[items]	<latest_certificate>	Processed certificate.
latest_certificates.total	<integer>	The number of total requested certificates.	Optional;
latest_certificates.<prop>	<any>		Optional;

Links

latest_certificates: bulk_delete

Deletes a list of certificates.

POST http://{device}/api/npm.ssl_module/1.1/latest_certificates/bulk_delete

Request Body

Provide a latest_certs_bulk_deleter data object.

Response Body

Returns a latest_certs_bulk_deleter data object.

latest_certificates: get

Returns the list of certificates.

GET http://{device}/api/npm.ssl_module/1.1/latest_certificates{?has_rsa_key,ignored,topby,topn}

Response Body

Returns a latest_certificates data object.

Resource: ssl_module

SSL/TLS Module configuration.

http://{device}/api/npm.ssl_module/1.1/ssl_module

JSON

{
  "enabled": boolean
}

{
  "enabled": boolean
}

Property Name	Type	Description	Notes
ssl_module	<object>	SSL/TLS Module configuration.	Required properties: [enabled];
ssl_module.enabled	<boolean>	Enable/disable SSL Module.

Links

ssl_module: get

Returns the SSL/TLS Module configuration.

GET http://{device}/api/npm.ssl_module/1.1/ssl_module

Response Body

Returns a ssl_module data object.

ssl_module: set

Updates the SSL/TLS Module configuration.

PUT http://{device}/api/npm.ssl_module/1.1/ssl_module

Request Body

Provide a ssl_module data object.

Response Body

Returns a ssl_module data object.

Type: certificate_issuers_bulk_deleter

JSON

{
  "delete_all": boolean,
  "delete_ids": [
    integer
  ],
  <prop>: any
}

{
  "delete_all": boolean,
  "delete_ids": [
    integer
  ],
  <prop>: any
}

Property Name	Type	Description	Notes
certificate_issuers_bulk_deleter	<object>
certificate_issuers_bulk_deleter. delete_all	<boolean>	Delete all objects in the given configuration.	Optional;
certificate_issuers_bulk_deleter. delete_ids	<array of <integer>>	List of certificate issuers ids to delete.	Optional;
certificate_issuers_bulk_deleter. delete_ids[items]	<integer>
certificate_issuers_bulk_deleter.<prop>	<any>		Optional;

Type: certificate_issuers_list

List of the certificate issuers.

JSON

{
  "items": [ certificate_issuer ]
}

{
  "items": [ certificate_issuer ]
}

Property Name	Type	Description	Notes
certificate_issuers_list	<object>	List of the certificate issuers.	Required properties: [items];
certificate_issuers_list.items	<array of <certificate_issuer>>
certificate_issuers_list.items[items]	<certificate_issuer>	X509 certificate issuer

Type: certificate_issuers_mode

Certificate issuers list mode.

JSON

{
  "mode": certificate_issuers_mode_t
}

{
  "mode": certificate_issuers_mode_t
}

Property Name	Type	Description	Notes
certificate_issuers_mode	<object>	Certificate issuers list mode.	Required properties: [mode];
certificate_issuers_mode.mode	<certificate_issuers_mode_t>	X509 Certificates Mode.	Values: APPROVE, DENY;

Type: certificate_issuers_mode_t

X509 Certificates Mode.

JSON

string

string

Property Name	Type	Description	Notes
certificate_issuers_mode_t	<string>	X509 Certificates Mode.	Values: APPROVE, DENY;

Type: certs_bulk_deleter

JSON

{
  "delete_all": boolean,
  "delete_ids": [
    string
  ],
  <prop>: any
}

{
  "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 configuration.	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
}

{
  "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
}

{
  "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 configuration.	Optional;
latest_certs_bulk_deleter. delete_all_ignored	<boolean>	Delete all ignored certificates in the given configuration.	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;