Dokploy

certificates

POST/certificates.create

certificates-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

certificateIdstring

name
Required
string

Minimum length: 1

certificateData
Required
string

Minimum length: 1

privateKey
Required
string

Minimum length: 1

certificatePathstring

autoRenewboolean | null

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/certificates.create" \
  -d '{
  "certificateId": "string",
  "name": "string",
  "certificateData": "string",
  "privateKey": "string",
  "certificatePath": "string",
  "autoRenew": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/certificates.one

certificates-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

certificateId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/certificates.one?certificateId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/certificates.remove

certificates-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

certificateId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/certificates.remove" \
  -d '{
  "certificateId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/certificates.all

certificates-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/certificates.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

On this page