Update a certificate template

PATCH

/api/templates/{id}

curl --request PATCH \
  --url https://gateway.example.com/api/templates/550e8400-e29b-41d4-a716-446655440000 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "certType": "tls-server", "keyAlgorithm": "rsa-2048", "validityDays": 365, "keyUsage": [ "digitalSignature" ], "extKeyUsage": [ "example" ], "requireSans": true, "sanTypes": [ "dns", "ip" ], "subjectDnFields": {}, "crlDistributionPoints": [], "authorityInfoAccess": {}, "certificatePolicies": [], "customExtensions": [] }'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

object

name

string

>= 1 characters <= 255 characters

description

string

certType

string

Allowed values: tls-server tls-client code-signing email

keyAlgorithm

string

default: ecdsa-p256

Allowed values: rsa-2048 rsa-4096 ecdsa-p256 ecdsa-p384

validityDays

integer

default: 365 >= 1 <= 3650

keyUsage

Array<string>

Allowed values: digitalSignature keyEncipherment dataEncipherment keyAgreement nonRepudiation

extKeyUsage

Array<string>

requireSans

boolean

default: true

sanTypes

Array<string>

default: dns,ip

Allowed values: dns ip email uri

subjectDnFields

object

o

string

<= 255 characters

ou

string

<= 255 characters

l

string

<= 255 characters

st

string

<= 255 characters

c

string

<= 2 characters

serialNumber

string

<= 255 characters

crlDistributionPoints

Array<string>

default:

authorityInfoAccess

object

caIssuersUrl

string format: uri

<= 500 characters

certificatePolicies

Array<object>

default:

object

oid

required

string

/^\d+(\.\d+)+$/

qualifier

string

<= 1024 characters

customExtensions

Array<object>

default:

object

oid

required

string

/^\d+(\.\d+)+$/

critical

boolean

value

required

string

>= 4 characters <= 10000 characters /^[0-9a-fA-F]+$/

Responses

200

Successful response

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Web Server",
    "type": "tls-server",
    "validityDays": 90
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}