apis » npm.ssl_key_store » 1.0
NPM SSL Key Store v1.0
Created Nov 12, 2024 at 09:56 PM

Resource: key

A single SSL key

http://{device}/api/npm.ssl_key_store/1.0/keys/items/{id}
  • JSON
    • {
  "description": string,
  "id": integer,
  "name": string,
  "timestamp": integer
}
    Property Name Type Description Notes
    key <object> A single SSL key Required properties: [id, name];
    key.description <string> A brief description of the key Optional;
    key.id <integer> Key ID Read-only;
    key.name <string> The name of the key
    key.timestamp <integer> The time when this key was added, in Unix epoch seconds Read-only; Optional;

    key: delete

    DELETE http://{device}/api/npm.ssl_key_store/1.0/keys/items/{id}
    Response Body

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

    key: get

    GET http://{device}/api/npm.ssl_key_store/1.0/keys/items/{id}
    Response Body

    Returns a key data object.

    Resource: keys

    The SSL keys being stored

    http://{device}/api/npm.ssl_key_store/1.0/keys
  • JSON
    • {
  "items": [ key ]
}
    Property Name Type Description Notes
    keys <object> The SSL keys being stored Required properties: [items];
    keys.items <array of <key>>
    keys.items[items] <key> A single SSL key

    keys: get

    GET http://{device}/api/npm.ssl_key_store/1.0/keys
    Response Body

    Returns a keys data object.

    keys: import

    POST http://{device}/api/npm.ssl_key_store/1.0/keys/import
    Request Body

    Provide a request body with the following structure:

    Property Name Type Description Notes
    keys.links.import.request <object> Required properties: [name, key];
    keys.links.import.request.description <string> A brief description of the key Optional;
    keys.links.import.request.key <string> The key to import, in PEM format
    keys.links.import.request.name <string> The name of the key
    keys.links.import.request.passphrase <string> The passphrase to decode the key, if required Optional;
    Response Body

    Returns a key data object.