Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get information about SSL certificates configuration and status.

GET /web_cert

Returns information about SSL certificate status and renewal configuration.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE getWebCert --host https://$HOST:9443

Responses

application/json

200

Details of the certificate.

Property

Type & Description

letsEncrypt

boolean

If true, the certificate is obtained from Let's Encrypt service and renewed automatically. Otherwise, the certificate management is up to the administrator.

expirationTime

string

Installed certificate's expiration time in ISO 8601 format.

creationTime

string

Installed certificate's creation time in ISO 8601 format.

status

string

Describes certificate validity status.

Enum:

validnear_expirationexpireddomain_mismatchregeneratingunknown

paths

object

Paths to certificate-related files.

cert required string Path to the certificate PEM file.
key required string Path to the corresponding private key PEM file.
chain required string Path to the file containing certificate chain.

domain

string

The domain (Common Name) for which current certificate was issued.

issuer

string

Issuer value of the current certificate.

lastRenewalSuccess

string

Date and time in ISO 8601 format. Represents last successful Let's Encrypt certification. If there are no successful attempts its value is null. This property is omitted if letsEncrypt is off.

lastRenewalFailure

string

Date and time in ISO 8601 format. Represents last unsuccessful Let's Encrypt certification. If there are no successful attempts its value is null. This property is omitted if letsEncrypt is off.

Example

application/json

{
  "paths": {
    "cert": "/etc/oz_panel/certs/web_cert.pem",
    "key": "/etc/oz_panel/certs/web_key.pem",
    "chain": "/etc/oz_panel/certs/web_chain.pem"
  },
  "obtainedTime": "2018-07-11T13:11:05Z",
  "letsEncrypt": true,
  "issuer": "LE Intermediate X3",
  "expirationTime": "2018-10-09T13:11:05Z",
  "domain": "onedata.org"
}

403

Forbidden request.

404

Cluster hosts are not configured.

500

Internal server error.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}