Skip to content

Update a TLS certificate

PATCH
/certificates/{id}
curl --request PATCH \
--url https://sylve.lan:8181/api/certificates/1 \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "certificate": "example", "domain": "example", "dynamicDnsEntryId": 1, "name": "example", "privateKey": "example", "staging": true, "type": "imported", "validateDomain": true }'

Update the settings or material of an existing TLS certificate

id
required
integer
>= 1

Certificate ID

Certificate settings

Media typeapplication/json
object
certificate
string
domain
string
dynamicDnsEntryId
integer
name
string
privateKey
string
staging
boolean
type
string
Allowed values: imported self-signed lets-encrypt sylve-managed system-default
validateDomain
boolean

Success

Media typeapplication/json
object
data
object
active
boolean
domain
string
dynamicDnsEntryId
integer
fingerprint
string
id
integer
issuanceError
string
issuanceOperation
string
Allowed values: initial renewal
issuanceRetryAt
string
issuanceStatus
string
name
string
notAfter
string
notBefore
string
pending
boolean
ready
boolean
renewable
boolean
staging
boolean
type
string
Allowed values: imported self-signed lets-encrypt sylve-managed system-default
updatedAt
string
error
string
message
string
status
string
Example
{
"data": {
"issuanceOperation": "initial",
"type": "imported"
}
}

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Payload Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Bad Gateway

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}