Resource: certificate
The SSL Certificate presented to connecting Profiler devices
http://{device}/api/npm.profiler_certs/1.0/certificate
{ "expires_at": integer, "fingerprint": { "algorithm": string, "value": string }, "issuer": distingushed_name, "key": { "algorithm": string, "size": integer }, "pem": string, "subject": distingushed_name, "valid_at": integer }
Property Name | Type | Description | Notes |
---|---|---|---|
certificate | <object> | The SSL Certificate presented to connecting Profiler devices | Required properties: [issuer, subject, valid_at, expires_at, fingerprint, key, pem]; |
certificate.expires_at | <integer> | Time at which the certificate expires, in Unix epoch seconds | |
certificate.fingerprint | <object> | Certificate fingerprint information | Required properties: [algorithm, value]; |
certificate.fingerprint.algorithm | <string> | The algorithm used to calculate the fingerprint | |
certificate.fingerprint.value | <string> | Fingerprint value | |
certificate.issuer | <distingushed_name> | Distinguished name information | |
certificate.key | <object> | Certificate key information | Required properties: [algorithm, size]; |
certificate.key.algorithm | <string> | The algorithm used to generate the key | |
certificate.key.size | <integer> | The size (number of bits) of the key | |
certificate.pem | <string> | The certificate, in PEM format | |
certificate.subject | <distingushed_name> | Distinguished name information | |
certificate.valid_at | <integer> | Time at which the certificate becomes valid, in Unix epoch seconds |
Links
certificate: generate
Generate a new self-signed certificate and private key. This replaces the current certificate.
POST http://{device}/api/npm.profiler_certs/1.0/certificate/generateRequest Body
Provide a distingushed_name data object.
Response BodyReturns a certificate data object.
certificate: get
GET http://{device}/api/npm.profiler_certs/1.0/certificateResponse Body
Returns a certificate data object.
certificate: import
Import a new certificate and private key
POST http://{device}/api/npm.profiler_certs/1.0/certificate/importRequest Body
Provide a request body with the following structure:
{ "passphrase": string, "pem": any }
Property Name | Type | Description | Notes |
---|---|---|---|
certificate.links.import.request | <object> | Import request format | Required properties: [pem]; |
certificate.links.import.request. passphrase |
<string> | Optional passphrase to decrypt private key | Optional; |
certificate.links.import.request.pem | <any> | Certificate and private key to import, in PEM format |
Returns a certificate data object.
Resource: trusted_certificate
A certificate or CA-certificate to be trusted
http://{device}/api/npm.profiler_certs/1.0/trusted_certificates/items/{id}
{ "cert_details": { "expires_at": integer, "fingerprint": { "algorithm": string, "value": string }, "issuer": distingushed_name, "key": { "algorithm": string, "size": integer }, "subject": distingushed_name, "valid_at": integer }, "id": integer, "name": string, "pem": string }
Property Name | Type | Description | Notes |
---|---|---|---|
trusted_certificate | <object> | A certificate or CA-certificate to be trusted | Required properties: [name, pem]; |
trusted_certificate.cert_details | <object> | Certificate details | Read-only; Optional; |
trusted_certificate.cert_details. expires_at |
<integer> | Time at which the certificate expires, in Unix epoch seconds | Read-only; Optional; |
trusted_certificate.cert_details. fingerprint |
<object> | Certificate fingerprint information | Read-only; Required properties: [algorithm, value]; Optional; |
trusted_certificate.cert_details. fingerprint.algorithm |
<string> | The algorithm used to calculate the fingerprint | Read-only; |
trusted_certificate.cert_details. fingerprint.value |
<string> | Fingerprint value | Read-only; |
trusted_certificate.cert_details.issuer | <distingushed_name> | Distinguished name information | |
trusted_certificate.cert_details.key | <object> | Certificate key information | Read-only; Required properties: [algorithm, size]; Optional; |
trusted_certificate.cert_details.key. algorithm |
<string> | The algorithm used to generate the key | Read-only; |
trusted_certificate.cert_details.key. size |
<integer> | The size (number of bits) of the key | Read-only; |
trusted_certificate.cert_details.subject | <distingushed_name> | Distinguished name information | |
trusted_certificate.cert_details. valid_at |
<integer> | Time at which the certificate becomes valid, in Unix epoch seconds | Read-only; Optional; |
trusted_certificate.id | <integer> | Server-assigned identifier for this trusted certificate | Read-only; Optional; |
trusted_certificate.name | <string> | Name of this certificate | |
trusted_certificate.pem | <string> | The certificate, in PEM format |
Links
trusted_certificate: delete
DELETE http://{device}/api/npm.profiler_certs/1.0/trusted_certificates/items/{id}Response Body
On success, the server does not provide any body in the responses.
trusted_certificate: get
GET http://{device}/api/npm.profiler_certs/1.0/trusted_certificates/items/{id}Response Body
Returns a trusted_certificate data object.
Resource: trusted_certificates
The list of all trusted certificates
http://{device}/api/npm.profiler_certs/1.0/trusted_certificates
{ "items": [ trusted_certificate ] }
Property Name | Type | Description | Notes |
---|---|---|---|
trusted_certificates | <object> | The list of all trusted certificates | Required properties: [items]; |
trusted_certificates.items | <array of <trusted_certificate>> | ||
trusted_certificates.items[items] | <trusted_certificate> | A certificate or CA-certificate to be trusted |
Links
trusted_certificates: create
POST http://{device}/api/npm.profiler_certs/1.0/trusted_certificatesRequest Body
Provide a trusted_certificate data object.
Response BodyReturns a trusted_certificate data object.
trusted_certificates: get
GET http://{device}/api/npm.profiler_certs/1.0/trusted_certificatesResponse Body
Returns a trusted_certificates data object.
Type: distingushed_name
Distinguished name information
{ "common_name": string, "country": string, "email": string, "locality": string, "organization": string, "organizational_unit": string, "state": string }
Property Name | Type | Description | Notes |
---|---|---|---|
distingushed_name | <object> | Distinguished name information | |
distingushed_name.common_name | <string> | Common name (CN) | Optional; |
distingushed_name.country | <string> | Country code (C) | Optional; |
distingushed_name.email | <string> | Email address | Optional; |
distingushed_name.locality | <string> | Locality (L) | Optional; |
distingushed_name.organization | <string> | Organization name (O) | Optional; |
distingushed_name.organizational_unit | <string> | Organization unit name (OU) | Optional; |
distingushed_name.state | <string> | State or province name (ST) | Optional; |