Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Modify SSL certificate configuration

PATCH /web_cert

Modifies configuration regarding certificate management. Allows enabling or disabling certificate autorenewal using Let's Encrypt service.

Request body

application/json

New values for certificate management configuration.

PropertyType & Description
letsEncrypt
boolean

If enabled Let's Encrypt service will be used to obtain SSL certificates and renew them before expiration. Otherwise certificates must be manually provided.

Request Examples

application/json 
{
  "letsEncrypt": true
}

Responses

application/json
204

Certificate configuration has been successfully modified.

400

Invalid request.

PropertyType & 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."
  }
}
401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

PropertyType & 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."
  }
}