certificate.update¶

Update certificate of id

Only name attribute can be updated.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: certificate_update

certificate_update

Type: object
No Additional Properties

Renew Days

Type: integer

Value must be greater or equal to 1 and lesser or equal to 30

Add To Trusted Store

Type: boolean

Name

Type: string

Must be at least 1 characters long

Must be at most 120 characters long

CertificateEntry

Type: object
No Additional Properties

Id

Type: integer

Type

Type: integer

Name

Type: string

Must be at least 1 characters long

Certificate

Type: string

Type: null

Privatekey

Any of

Option 1
Option 2

Type: string

Type: null

Csr

Any of

Option 1
Option 2

Type: string

Type: null

Acme Uri

Any of

Option 1
Option 2

Type: string

Type: null

Domains Authenticators

Any of

Option 1
Option 2

Type: object

Type: null

Renew Days

Any of

Option 1
Option 2

Type: integer

Type: null

Acme

Any of

Option 1
Option 2

Type: object

Type: null

Add To Trusted Store

Type: boolean

Root Path

Type: string

Must be at least 1 characters long

Certificate Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Privatekey Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Csr Path

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Cert Type

Type: string

Must be at least 1 characters long

Cert Type Existing

Type: boolean

Cert Type Csr

Type: boolean

Chain List

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Key Length

Any of

Option 1
Option 2

Type: integer

Type: null

Key Type

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Country

Any of

Option 1
Option 2

Type: string

Type: null

State

Any of

Option 1
Option 2

Type: string

Type: null

City

Any of

Option 1
Option 2

Type: string

Type: null

Organization

Any of

Option 1
Option 2

Type: string

Type: null

Organizational Unit

Any of

Option 1
Option 2

Type: string

Type: null

Common

Any of

Option 1
Option 2

Type: string

Type: null

San

Any of

Option 1
Option 2

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Type: null

Email

Any of

Option 1
Option 2

Type: string

Type: null

Dn

Any of

Option 1
Option 2

Type: string

Type: null

Subject Name Hash

Any of

Option 1
Option 2

Type: integer

Type: null

Extensions

Type: object

Digest Algorithm

Any of

Option 1
Option 2

Type: string

Type: null

Lifetime

Any of

Option 1
Option 2

Type: integer

Type: null

From

Any of

Option 1
Option 2

Type: string

Type: null

Until

Any of

Option 1
Option 2

Type: string

Type: null

Serial

Any of

Option 1
Option 2

Type: integer

Type: null

Chain

Any of

Option 1
Option 2

Type: boolean

Type: null

Fingerprint

Any of

Option 1
Option 2

Type: string

Type: null

Expired

Any of

Option 1
Option 2

Type: boolean

Type: null

Parsed

Type: boolean

Required roles: CERTIFICATE_WRITE

Table Of Contents

Previous topic

Next topic

certificate.update¶

Call parameters

Tuple Validation

Parameter 1: id

id

Parameter 2: certificate_update

certificate_update

renew_days

Renew Days

add_to_trusted_store

Add To Trusted Store

name

Name

Return value

CertificateEntry

id Required

Id

type Required

Type

name Required

Name

certificate Required

Certificate

Any of

privatekey Required

Privatekey

Any of

CSR Required

Csr

Any of

acme_uri Required

Acme Uri

Any of

domains_authenticators Required

Domains Authenticators

Any of

renew_days Required

Renew Days

Any of

acme Required

Acme

Any of

add_to_trusted_store Required

Add To Trusted Store

root_path Required

Root Path

certificate_path Required

Certificate Path

Any of

privatekey_path Required

Privatekey Path

Any of

csr_path Required

Csr Path

Any of

cert_type Required

Cert Type

cert_type_existing Required

Cert Type Existing

cert_type_CSR Required

Cert Type Csr

chain_list Required

Chain List

Each item of this array must be:

key_length Required

Key Length

Any of

key_type Required

Key Type

Any of

country Required

Country

Any of

state Required

State

Any of

city Required