Merge pull request #4943 from Infisical/misc/revamp-pki-apis

misc: standardized PKI endpoints
This commit is contained in:
Sheen
2025-11-29 03:48:13 +08:00
committed by GitHub
205 changed files with 4192 additions and 1309 deletions

View File

@@ -1,4 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/pki/ca/acme"
openapi: "POST /api/v1/cert-manager/ca/acme"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/pki/ca/acme/{caName}"
openapi: "DELETE /api/v1/cert-manager/ca/acme/{id}"
---

View File

@@ -1,4 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/pki/ca/acme"
openapi: "GET /api/v1/cert-manager/ca/acme"
---

View File

@@ -1,4 +1,4 @@
---
title: "Read"
openapi: "GET /api/v1/pki/ca/acme/{caName}"
openapi: "GET /api/v1/cert-manager/ca/acme/{id}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/pki/ca/acme/{caName}"
openapi: "PATCH /api/v1/cert-manager/ca/acme/{id}"
---

View File

@@ -1,4 +0,0 @@
---
title: "Retrieve certificate / chain"
openapi: "GET /api/v1/pki/ca/{caId}/certificate"
---

View File

@@ -1,8 +0,0 @@
---
title: "Create (Deprecated)"
openapi: "POST /api/v1/pki/ca"
---
<Note>
This endpoint is deprecated. Please use the internal CA endpoint [here](/api-reference/endpoints/certificate-authorities/internal/create).
</Note>

View File

@@ -1,4 +0,0 @@
---
title: "List CRLs"
openapi: "GET /api/v1/pki/ca/{caId}/crls"
---

View File

@@ -1,4 +0,0 @@
---
title: "Get CSR"
openapi: "GET /api/v1/pki/ca/{caId}/csr"
---

View File

@@ -1,8 +0,0 @@
---
title: "Delete (Deprecated)"
openapi: "DELETE /api/v1/pki/ca/{caId}"
---
<Note>
This endpoint is deprecated. Please use the internal CA endpoint [here](/api-reference/endpoints/certificate-authorities/internal/delete).
</Note>

View File

@@ -1,4 +0,0 @@
---
title: "Import certificate"
openapi: "POST /api/v1/pki/ca/{caId}/import-certificate"
---

View File

@@ -0,0 +1,4 @@
---
title: "Retrieve certificate / chain"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/certificate"
---

View File

@@ -1,4 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/pki/ca/internal"
openapi: "POST /api/v1/cert-manager/ca/internal"
---

View File

@@ -0,0 +1,4 @@
---
title: "List CRLs"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/crls"
---

View File

@@ -0,0 +1,4 @@
---
title: "Get CSR"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/csr"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/pki/ca/internal/{caName}"
openapi: "DELETE /api/v1/cert-manager/ca/internal/{id}"
---

View File

@@ -0,0 +1,4 @@
---
title: "Import certificate"
openapi: "POST /api/v1/cert-manager/ca/internal/{caId}/import-certificate"
---

View File

@@ -0,0 +1,4 @@
---
title: "List CA certificates"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/ca-certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/pki/ca/internal"
openapi: "GET /api/v1/cert-manager/ca/internal"
---

View File

@@ -1,4 +1,4 @@
---
title: "Read"
openapi: "GET /api/v1/pki/ca/internal/{caName}"
openapi: "GET /api/v1/cert-manager/ca/internal/{id}"
---

View File

@@ -0,0 +1,4 @@
---
title: "Renew"
openapi: "POST /api/v1/cert-manager/ca/internal/{caId}/renew"
---

View File

@@ -0,0 +1,4 @@
---
title: "Sign intermediate certificate"
openapi: "POST /api/v1/cert-manager/ca/internal/{caId}/sign-intermediate"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/pki/ca/internal/{caName}"
openapi: "PATCH /api/v1/cert-manager/ca/internal/{id}"
---

View File

@@ -1,4 +0,0 @@
---
title: "List CA certificates"
openapi: "GET /api/v1/pki/ca/{caId}/ca-certificates"
---

View File

@@ -1,8 +0,0 @@
---
title: "List (Deprecated)"
openapi: "GET /api/v2/workspace/{slug}/cas"
---
<Note>
This endpoint is deprecated. Please use the internal CA endpoint [here](/api-reference/endpoints/certificate-authorities/internal/list).
</Note>

View File

@@ -1,8 +0,0 @@
---
title: "Retrieve (Deprecated)"
openapi: "GET /api/v1/pki/ca/{caId}"
---
<Note>
This endpoint is deprecated. Please use the internal CA endpoint [here](/api-reference/endpoints/certificate-authorities/internal/read).
</Note>

View File

@@ -1,4 +0,0 @@
---
title: "Renew"
openapi: "POST /api/v1/pki/ca/{caId}/renew"
---

View File

@@ -1,4 +0,0 @@
---
title: "Sign intermediate certificate"
openapi: "POST /api/v1/pki/ca/{caId}/sign-intermediate"
---

View File

@@ -1,8 +0,0 @@
---
title: "Update (Deprecated)"
openapi: "PATCH /api/v1/pki/ca/{caId}"
---
<Note>
This endpoint is deprecated. Please use the internal CA endpoint [here](/api-reference/endpoints/certificate-authorities/internal/update).
</Note>

View File

@@ -1,4 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/pki/certificate-profiles"
openapi: "POST /api/v1/cert-manager/certificate-profiles"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/pki/certificate-profiles/{id}"
openapi: "DELETE /api/v1/cert-manager/certificate-profiles/{id}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v1/pki/certificate-profiles/{id}"
openapi: "GET /api/v1/cert-manager/certificate-profiles/{id}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get by Slug"
openapi: "GET /api/v1/pki/certificate-profiles/slug/{slug}"
openapi: "GET /api/v1/cert-manager/certificate-profiles/slug/{slug}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get Latest Active Certificate Bundle"
openapi: "GET /api/v1/pki/certificate-profiles/{id}/certificates/latest-active-bundle"
openapi: "GET /api/v1/cert-manager/certificate-profiles/{id}/certificates/latest-active-bundle"
---

View File

@@ -1,4 +1,4 @@
---
title: "List Certificates"
openapi: "GET /api/v1/pki/certificate-profiles/{id}/certificates"
openapi: "GET /api/v1/cert-manager/certificate-profiles/{id}/certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/pki/certificate-profiles"
openapi: "GET /api/v1/cert-manager/certificate-profiles"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/pki/certificate-profiles/{id}"
openapi: "PATCH /api/v1/cert-manager/certificate-profiles/{id}"
---

View File

@@ -1,4 +1,4 @@
---
title: "List PKI Syncs"
openapi: "GET /api/v1/pki/syncs"
openapi: "GET /api/v1/cert-manager/syncs"
---

View File

@@ -1,4 +1,4 @@
---
title: "Options"
openapi: "GET /api/v1/pki/syncs/options"
openapi: "GET /api/v1/cert-manager/syncs/options"
---

View File

@@ -1,4 +0,0 @@
---
title: "Create"
openapi: "POST /api/v2/certificate-templates"
---

View File

@@ -1,4 +0,0 @@
---
title: "Delete"
openapi: "DELETE /api/v2/certificate-templates/{id}"
---

View File

@@ -1,4 +0,0 @@
---
title: "Get by ID"
openapi: "GET /api/v2/certificate-templates/{id}"
---

View File

@@ -1,4 +0,0 @@
---
title: "List"
openapi: "GET /api/v2/certificate-templates"
---

View File

@@ -1,4 +0,0 @@
---
title: "Update"
openapi: "PATCH /api/v2/certificate-templates/{id}"
---

View File

@@ -0,0 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/cert-manager/certificate-templates"
---

View File

@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/cert-manager/certificate-templates/{id}"
---

View File

@@ -0,0 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v1/cert-manager/certificate-templates/{id}"
---

View File

@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/cert-manager/certificate-templates"
---

View File

@@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/cert-manager/certificate-templates/{id}"
---

View File

@@ -1,6 +1,6 @@
---
title: "Get Certificate Bundle"
openapi: "GET /api/v1/pki/certificates/{serialNumber}/bundle"
openapi: "GET /api/v1/cert-manager/certificates/{id}/bundle"
---
<Note>

View File

@@ -1,4 +1,4 @@
---
title: "Get Certificate Body / Chain"
openapi: "GET /api/v1/pki/certificates/{serialNumber}/certificate"
openapi: "GET /api/v1/cert-manager/certificates/{id}/certificate"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/pki/certificates/{serialNumber}"
openapi: "DELETE /api/v1/cert-manager/certificates/{id}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Issue Certificate"
openapi: "POST /api/v3/pki/certificates/issue-certificate"
openapi: "POST /api/v1/cert-manager/certificates/issue-certificate"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get Certificate Private Key"
openapi: "GET /api/v1/pki/certificates/{serialNumber}/private-key"
openapi: "GET /api/v1/cert-manager/certificates/{id}/private-key"
---

View File

@@ -1,4 +1,4 @@
---
title: "Retrieve"
openapi: "GET /api/v1/pki/certificates/{serialNumber}"
openapi: "GET /api/v1/cert-manager/certificates/{id}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Renew Certificate"
openapi: "POST /api/v3/pki/certificates/{certificateId}/renew"
openapi: "POST /api/v1/cert-manager/certificates/{id}/renew"
---

View File

@@ -1,4 +1,4 @@
---
title: "Revoke"
openapi: "POST /api/v1/pki/certificates/{serialNumber}/revoke"
openapi: "POST /api/v1/cert-manager/certificates/{id}/revoke"
---

View File

@@ -1,4 +1,4 @@
---
title: "Sign Certificate"
openapi: "POST /api/v3/pki/certificates/sign-certificate"
openapi: "POST /api/v1/cert-manager/certificates/sign-certificate"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update Certificate Config"
openapi: "PATCH /api/v3/pki/certificates/{certificateId}/config"
openapi: "PATCH /api/v1/cert-manager/certificates/{id}/config"
---

View File

@@ -1,4 +1,4 @@
---
title: "Create"
openapi: "POST /api/v2/pki/alerts"
openapi: "POST /api/v1/cert-manager/alerts"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v2/pki/alerts/{alertId}"
openapi: "DELETE /api/v1/cert-manager/alerts/{alertId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Retrieve"
openapi: "GET /api/v2/pki/alerts/{alertId}"
openapi: "GET /api/v1/cert-manager/alerts/{alertId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v2/pki/alerts/{alertId}"
openapi: "PATCH /api/v1/cert-manager/alerts/{alertId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Add Certificates to Sync"
openapi: "POST /api/v1/pki/syncs/{pkiSyncId}/certificates"
openapi: "POST /api/v1/cert-manager/syncs/{pkiSyncId}/certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "Create AWS Certificate Manager PKI Sync"
openapi: "POST /api/v1/pki/syncs/aws-certificate-manager"
openapi: "POST /api/v1/cert-manager/syncs/aws-certificate-manager"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete AWS Certificate Manager PKI Sync"
openapi: "DELETE /api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}"
openapi: "DELETE /api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get AWS Certificate Manager PKI Sync by ID"
openapi: "GET /api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}"
openapi: "GET /api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "List AWS Certificate Manager PKI Syncs"
openapi: "GET /api/v1/pki/syncs/aws-certificate-manager"
openapi: "GET /api/v1/cert-manager/syncs/aws-certificate-manager"
---

View File

@@ -1,4 +1,4 @@
---
title: "Remove Certificates from AWS Certificate Manager"
openapi: "POST /api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}/remove-certificates"
openapi: "POST /api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}/remove-certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "Sync Certificates to AWS Certificate Manager"
openapi: "POST /api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}/sync"
openapi: "POST /api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}/sync"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update AWS Certificate Manager PKI Sync"
openapi: "PATCH /api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}"
openapi: "PATCH /api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Create AWS Secrets Manager PKI Sync"
openapi: "POST /api/v1/pki/syncs/aws-secrets-manager"
openapi: "POST /api/v1/cert-manager/syncs/aws-secrets-manager"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete AWS Secrets Manager PKI Sync"
openapi: "DELETE /api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}"
openapi: "DELETE /api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get AWS Secrets Manager PKI Sync by ID"
openapi: "GET /api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}"
openapi: "GET /api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "List AWS Secrets Manager PKI Syncs"
openapi: "GET /api/v1/pki/syncs/aws-secrets-manager"
openapi: "GET /api/v1/cert-manager/syncs/aws-secrets-manager"
---

View File

@@ -1,4 +1,4 @@
---
title: "Remove Certificates from AWS Secrets Manager"
openapi: "POST /api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}/remove-certificates"
openapi: "POST /api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}/remove-certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "Sync Certificates to AWS Secrets Manager"
openapi: "POST /api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}/sync-certificates"
openapi: "POST /api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}/sync"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update AWS Secrets Manager PKI Sync"
openapi: "PATCH /api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}"
openapi: "PATCH /api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Create Azure Key Vault PKI Sync"
openapi: "POST /api/v1/pki/syncs/azure-key-vault"
openapi: "POST /api/v1/cert-manager/syncs/azure-key-vault"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete Azure Key Vault PKI Sync"
openapi: "DELETE /api/v1/pki/syncs/azure-key-vault/{pkiSyncId}"
openapi: "DELETE /api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get Azure Key Vault PKI Sync by ID"
openapi: "GET /api/v1/pki/syncs/azure-key-vault/{pkiSyncId}"
openapi: "GET /api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "List Azure Key Vault PKI Syncs"
openapi: "GET /api/v1/pki/syncs/azure-key-vault"
openapi: "GET /api/v1/cert-manager/syncs/azure-key-vault"
---

View File

@@ -1,4 +1,4 @@
---
title: "Remove Certificates from Azure Key Vault"
openapi: "POST /api/v1/pki/syncs/azure-key-vault/{pkiSyncId}/remove-certificates"
openapi: "POST /api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}/remove-certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "Sync Certificates to Azure Key Vault"
openapi: "POST /api/v1/pki/syncs/azure-key-vault/{pkiSyncId}/sync"
openapi: "POST /api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}/sync"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update Azure Key Vault PKI Sync"
openapi: "PATCH /api/v1/pki/syncs/azure-key-vault/{pkiSyncId}"
openapi: "PATCH /api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Create Chef PKI Sync"
openapi: "POST /api/v1/pki/syncs/chef"
openapi: "POST /api/v1/cert-manager/syncs/chef"
---

View File

@@ -1,4 +1,4 @@
---
title: "Delete Chef PKI Sync"
openapi: "DELETE /api/v1/pki/syncs/chef/{pkiSyncId}"
openapi: "DELETE /api/v1/cert-manager/syncs/chef/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get Chef PKI Sync by ID"
openapi: "GET /api/v1/pki/syncs/chef/{pkiSyncId}"
openapi: "GET /api/v1/cert-manager/syncs/chef/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "List Chef PKI Syncs"
openapi: "GET /api/v1/pki/syncs/chef"
openapi: "GET /api/v1/cert-manager/syncs/chef"
---

View File

@@ -1,4 +1,4 @@
---
title: "Remove Certificates from Chef"
openapi: "POST /api/v1/pki/syncs/chef/{pkiSyncId}/remove-certificates"
openapi: "POST /api/v1/cert-manager/syncs/chef/{pkiSyncId}/remove-certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "Sync Certificates to Chef"
openapi: "POST /api/v1/pki/syncs/chef/{pkiSyncId}/sync"
openapi: "POST /api/v1/cert-manager/syncs/chef/{pkiSyncId}/sync"
---

View File

@@ -1,4 +1,4 @@
---
title: "Update Chef PKI Sync"
openapi: "PATCH /api/v1/pki/syncs/chef/{pkiSyncId}"
openapi: "PATCH /api/v1/cert-manager/syncs/chef/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "Get PKI Sync by ID"
openapi: "GET /api/v1/pki/syncs/{pkiSyncId}"
openapi: "GET /api/v1/cert-manager/syncs/{pkiSyncId}"
---

View File

@@ -1,4 +1,4 @@
---
title: "List Sync Certificates"
openapi: "GET /api/v1/pki/syncs/{pkiSyncId}/certificates"
openapi: "GET /api/v1/cert-manager/syncs/{pkiSyncId}/certificates"
---

View File

@@ -1,4 +1,4 @@
---
title: "List PKI Syncs"
openapi: "GET /api/v1/pki/syncs"
openapi: "GET /api/v1/cert-manager/syncs"
---

View File

@@ -1,4 +1,4 @@
---
title: "List PKI Sync Options"
openapi: "GET /api/v1/pki/syncs/options"
openapi: "GET /api/v1/cert-manager/syncs/options"
---

View File

@@ -1,4 +1,4 @@
---
title: "Remove Certificates from Sync"
openapi: "DELETE /api/v1/pki/syncs/{pkiSyncId}/certificates"
openapi: "DELETE /api/v1/cert-manager/syncs/{pkiSyncId}/certificates"
---