Create a certificate

POST /apisix/admin/certificates

Interactive request editor loads with JavaScript.

Query Parameters

gateway_group_id*string

Gateway group ID. Optional when using the gateway group admin key to authenticate.

Length1 <= length

Request Body

application/json

The certificate description.

name?string

The object name.

Length1 <= length <= 65536

desc?string

The object description.

Lengthlength <= 65536

cert*|

Certificate.

labels?

Key-value pairs of labels.

key*|

Private key.

Response Body

`application/json`

curl -X POST "$API_BASE_URL/apisix/admin/certificates?gateway_group_id=86fb9981-d9d2-4555-9df8-91ae92129335" \  -H "Content-Type: application/json" \  -d '{}'

Certificate created successfully.

{
  "value": {
    "name": "us-west-rsc",
    "desc": "Object description.",
    "cert": "$secret://aws/john/apisix-secrets/john-key-auth",
    "labels": {
      "version": "v2",
      "env": "prod"
    },
    "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
    "created_at": 1742288232,
    "updated_at": 1742288235,
    "common_name": "example.com",
    "subject_alt_names": [
      "www.example.com"
    ],
    "associated_snis": [
      "1cf56bfe-7727-4584-93f2-9d09271bd42a"
    ],
    "exptime": 1735680000,
    "validity_start": 1714540800,
    "validity_end": 1730419200
  }
}

Complete operation details and schema variants

POST /apisix/admin/certificates

Create a certificate

Create a TLS server certificate for the gateway group, including the certificate chain and private key used for HTTPS termination. Required IAM Permission: Action gateway:CreateCertificate, Resource arn:api7:gateway:gatewaygroup/%s

Parameters

gateway_group_id (query, string, required): Gateway group ID. Optional when using the gateway group admin key to authenticate.

Request body

Content type: application/json

allOf variant 1
name (string, optional): The object name.
desc (string, optional): The object description.
cert (string, optional): Certificate.
oneOf variant 1: Certificate Reference
oneOf variant 2: Certificate Content
labels (object, optional): Key-value pairs of labels.
allOf variant 2
key (string, optional): Private key.
oneOf variant 1: Private Key Reference
oneOf variant 2: Private Key Content

Responses

200: Certificate created successfully.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional): The Certificate response format, with filtering the sensitive fields and some other fields.
allOf variant 1
value.name (string, optional): The object name.
value.desc (string, optional): The object description.
value.cert (string, optional): Certificate.
oneOf variant 1: Certificate Reference
oneOf variant 2: Certificate Content
value.labels (object, optional): Key-value pairs of labels.
allOf variant 2
value.id (string, optional): The object ID.
value.created_at (integer, optional): The object created timestamp.
value.updated_at (integer, optional): The object updated timestamp.
value.common_name (string, optional): The common name of the certificate.
value.subject_alt_names (array, optional): The subject alternative names of the certificate.
value.associated_snis (array, optional): The SNI IDs associated with the certificate.
value.exptime (integer, optional): The SSL certificate expire time.
value.validity_start (integer, optional): The earliest time when the SSL certificate is used.
value.validity_end (integer, optional): The latest time when the SSL certificate is used.

cURL

curl -X POST '$API_BASE_URL/apisix/admin/certificates'

Create a certificate

200application/json

`application/json`