mics: updated docs

This commit is contained in:
Sheen Capadngan
2025-11-26 04:10:05 +08:00
parent 6754da9c21
commit 1531048d25
110 changed files with 171 additions and 228 deletions
@@ -360,7 +360,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
server.route({ server.route({
method: "POST", method: "POST",
url: "/:certificateId/renew", url: "/:id/renew",
config: { config: {
rateLimit: writeLimit rateLimit: writeLimit
}, },
@@ -368,7 +368,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
hide: false, hide: false,
tags: [ApiDocsTags.PkiCertificates], tags: [ApiDocsTags.PkiCertificates],
params: z.object({ params: z.object({
certificateId: z.string().uuid() id: z.string().uuid()
}), }),
body: z body: z
.object({ .object({
@@ -393,7 +393,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
actorId: req.permission.id, actorId: req.permission.id,
actorAuthMethod: req.permission.authMethod, actorAuthMethod: req.permission.authMethod,
actorOrgId: req.permission.orgId, actorOrgId: req.permission.orgId,
certificateId: req.params.certificateId, certificateId: req.params.id,
removeRootsFromChain: req.body?.removeRootsFromChain removeRootsFromChain: req.body?.removeRootsFromChain
}); });
@@ -403,7 +403,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
event: { event: {
type: EventType.RENEW_CERTIFICATE, type: EventType.RENEW_CERTIFICATE,
metadata: { metadata: {
originalCertificateId: req.params.certificateId, originalCertificateId: req.params.id,
newCertificateId: data.certificateId, newCertificateId: data.certificateId,
profileName: data.profileName, profileName: data.profileName,
commonName: data.commonName commonName: data.commonName
@@ -417,7 +417,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
server.route({ server.route({
method: "PATCH", method: "PATCH",
url: "/:certificateId/config", url: "/:id/config",
config: { config: {
rateLimit: writeLimit rateLimit: writeLimit
}, },
@@ -425,7 +425,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
hide: false, hide: false,
tags: [ApiDocsTags.PkiCertificates], tags: [ApiDocsTags.PkiCertificates],
params: z.object({ params: z.object({
certificateId: z.string().uuid() id: z.string().uuid()
}), }),
body: z body: z
.object({ .object({
@@ -450,7 +450,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
actorId: req.permission.id, actorId: req.permission.id,
actorAuthMethod: req.permission.authMethod, actorAuthMethod: req.permission.authMethod,
actorOrgId: req.permission.orgId, actorOrgId: req.permission.orgId,
certificateId: req.params.certificateId certificateId: req.params.id
}); });
await server.services.auditLog.createAuditLog({ await server.services.auditLog.createAuditLog({
@@ -459,7 +459,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
event: { event: {
type: EventType.DISABLE_CERTIFICATE_RENEWAL_CONFIG, type: EventType.DISABLE_CERTIFICATE_RENEWAL_CONFIG,
metadata: { metadata: {
certificateId: req.params.certificateId, certificateId: req.params.id,
commonName: data.commonName commonName: data.commonName
} }
} }
@@ -476,7 +476,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
actorId: req.permission.id, actorId: req.permission.id,
actorAuthMethod: req.permission.authMethod, actorAuthMethod: req.permission.authMethod,
actorOrgId: req.permission.orgId, actorOrgId: req.permission.orgId,
certificateId: req.params.certificateId, certificateId: req.params.id,
renewBeforeDays: req.body.renewBeforeDays renewBeforeDays: req.body.renewBeforeDays
}); });
@@ -486,7 +486,7 @@ export const registerCertificateRouter = async (server: FastifyZodProvider) => {
event: { event: {
type: EventType.UPDATE_CERTIFICATE_RENEWAL_CONFIG, type: EventType.UPDATE_CERTIFICATE_RENEWAL_CONFIG,
metadata: { metadata: {
certificateId: req.params.certificateId, certificateId: req.params.id,
renewBeforeDays: req.body.renewBeforeDays.toString(), renewBeforeDays: req.body.renewBeforeDays.toString(),
commonName: data.commonName commonName: data.commonName
} }
@@ -1,4 +1,4 @@
--- ---
title: "Create" title: "Create"
openapi: "POST /api/v1/pki/ca/acme" openapi: "POST /api/v1/cert-manager/ca/acme"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Delete" title: "Delete"
openapi: "DELETE /api/v1/pki/ca/acme/{caName}" openapi: "DELETE /api/v1/cert-manager/ca/acme/{id}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List" title: "List"
openapi: "GET /api/v1/pki/ca/acme" openapi: "GET /api/v1/cert-manager/ca/acme"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Read" title: "Read"
openapi: "GET /api/v1/pki/ca/acme/{caName}" openapi: "GET /api/v1/cert-manager/ca/acme/{id}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Update" title: "Update"
openapi: "PATCH /api/v1/pki/ca/acme/{caName}" openapi: "PATCH /api/v1/cert-manager/ca/acme/{id}"
--- ---
@@ -1,4 +0,0 @@
---
title: "Retrieve certificate / chain"
openapi: "GET /api/v1/pki/ca/{caId}/certificate"
---
@@ -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>
@@ -1,4 +0,0 @@
---
title: "List CRLs"
openapi: "GET /api/v1/pki/ca/{caId}/crls"
---
@@ -1,4 +0,0 @@
---
title: "Get CSR"
openapi: "GET /api/v1/pki/ca/{caId}/csr"
---
@@ -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>
@@ -1,4 +0,0 @@
---
title: "Import certificate"
openapi: "POST /api/v1/pki/ca/{caId}/import-certificate"
---
@@ -0,0 +1,4 @@
---
title: "Retrieve certificate / chain"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/certificate"
---
@@ -1,4 +1,4 @@
--- ---
title: "Create" title: "Create"
openapi: "POST /api/v1/pki/ca/internal" openapi: "POST /api/v1/cert-manager/ca/internal"
--- ---
@@ -0,0 +1,4 @@
---
title: "List CRLs"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/crls"
---
@@ -0,0 +1,4 @@
---
title: "Get CSR"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/csr"
---
@@ -1,4 +1,4 @@
--- ---
title: "Delete" title: "Delete"
openapi: "DELETE /api/v1/pki/ca/internal/{caName}" openapi: "DELETE /api/v1/cert-manager/ca/internal/{id}"
--- ---
@@ -0,0 +1,4 @@
---
title: "Import certificate"
openapi: "POST /api/v1/cert-manager/ca/internal/{caId}/import-certificate"
---
@@ -0,0 +1,4 @@
---
title: "List CA certificates"
openapi: "GET /api/v1/cert-manager/ca/internal/{caId}/ca-certificates"
---
@@ -1,4 +1,4 @@
--- ---
title: "List" title: "List"
openapi: "GET /api/v1/pki/ca/internal" openapi: "GET /api/v1/cert-manager/ca/internal"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Read" title: "Read"
openapi: "GET /api/v1/pki/ca/internal/{caName}" openapi: "GET /api/v1/cert-manager/ca/internal/{id}"
--- ---
@@ -0,0 +1,4 @@
---
title: "Renew"
openapi: "POST /api/v1/cert-manager/ca/internal/{caId}/renew"
---
@@ -0,0 +1,4 @@
---
title: "Sign intermediate certificate"
openapi: "POST /api/v1/cert-manager/ca/internal/{caId}/sign-intermediate"
---
@@ -1,4 +1,4 @@
--- ---
title: "Update" title: "Update"
openapi: "PATCH /api/v1/pki/ca/internal/{caName}" openapi: "PATCH /api/v1/cert-manager/ca/internal/{id}"
--- ---
@@ -1,4 +0,0 @@
---
title: "List CA certificates"
openapi: "GET /api/v1/pki/ca/{caId}/ca-certificates"
---
@@ -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>
@@ -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>
@@ -1,4 +0,0 @@
---
title: "Renew"
openapi: "POST /api/v1/pki/ca/{caId}/renew"
---
@@ -1,4 +0,0 @@
---
title: "Sign intermediate certificate"
openapi: "POST /api/v1/pki/ca/{caId}/sign-intermediate"
---
@@ -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>
@@ -1,4 +1,4 @@
--- ---
title: "Create" title: "Create"
openapi: "POST /api/v1/pki/certificate-profiles" openapi: "POST /api/v1/cert-manager/certificate-profiles"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Delete" title: "Delete"
openapi: "DELETE /api/v1/pki/certificate-profiles/{id}" openapi: "DELETE /api/v1/cert-manager/certificate-profiles/{id}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get by ID" title: "Get by ID"
openapi: "GET /api/v1/pki/certificate-profiles/{id}" openapi: "GET /api/v1/cert-manager/certificate-profiles/{id}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get by Slug" title: "Get by Slug"
openapi: "GET /api/v1/pki/certificate-profiles/slug/{slug}" openapi: "GET /api/v1/cert-manager/certificate-profiles/slug/{slug}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get Latest Active Certificate Bundle" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List Certificates" title: "List Certificates"
openapi: "GET /api/v1/pki/certificate-profiles/{id}/certificates" openapi: "GET /api/v1/cert-manager/certificate-profiles/{id}/certificates"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List" title: "List"
openapi: "GET /api/v1/pki/certificate-profiles" openapi: "GET /api/v1/cert-manager/certificate-profiles"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Update" title: "Update"
openapi: "PATCH /api/v1/pki/certificate-profiles/{id}" openapi: "PATCH /api/v1/cert-manager/certificate-profiles/{id}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List PKI Syncs" title: "List PKI Syncs"
openapi: "GET /api/v1/pki/syncs" openapi: "GET /api/v1/cert-manager/syncs"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Options" title: "Options"
openapi: "GET /api/v1/pki/syncs/options" openapi: "GET /api/v1/cert-manager/syncs/options"
--- ---
@@ -1,4 +0,0 @@
---
title: "Create"
openapi: "POST /api/v2/certificate-templates"
---
@@ -1,4 +0,0 @@
---
title: "Delete"
openapi: "DELETE /api/v2/certificate-templates/{id}"
---
@@ -1,4 +0,0 @@
---
title: "Get by ID"
openapi: "GET /api/v2/certificate-templates/{id}"
---
@@ -1,4 +0,0 @@
---
title: "List"
openapi: "GET /api/v2/certificate-templates"
---
@@ -1,4 +0,0 @@
---
title: "Update"
openapi: "PATCH /api/v2/certificate-templates/{id}"
---
@@ -0,0 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/cert-manager/certificate-templates"
---
@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/cert-manager/certificate-templates/{id}"
---
@@ -0,0 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v1/cert-manager/certificate-templates/{id}"
---
@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/cert-manager/certificate-templates"
---
@@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/cert-manager/certificate-templates/{id}"
---
@@ -1,6 +1,6 @@
--- ---
title: "Get Certificate Bundle" title: "Get Certificate Bundle"
openapi: "GET /api/v1/pki/certificates/{serialNumber}/bundle" openapi: "GET /api/v1/cert-manager/certificates/{id}/bundle"
--- ---
<Note> <Note>
@@ -1,4 +1,4 @@
--- ---
title: "Get Certificate Body / Chain" title: "Get Certificate Body / Chain"
openapi: "GET /api/v1/pki/certificates/{serialNumber}/certificate" openapi: "GET /api/v1/cert-manager/certificates/{id}/certificate"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Delete" title: "Delete"
openapi: "DELETE /api/v1/pki/certificates/{serialNumber}" openapi: "DELETE /api/v1/cert-manager/certificates/{id}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Issue Certificate" title: "Issue Certificate"
openapi: "POST /api/v3/pki/certificates/issue-certificate" openapi: "POST /api/v1/cert-manager/certificates/issue-certificate"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get Certificate Private Key" title: "Get Certificate Private Key"
openapi: "GET /api/v1/pki/certificates/{serialNumber}/private-key" openapi: "GET /api/v1/cert-manager/certificates/{id}/private-key"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Retrieve" title: "Retrieve"
openapi: "GET /api/v1/pki/certificates/{serialNumber}" openapi: "GET /api/v1/cert-manager/certificates/{id}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Renew Certificate" title: "Renew Certificate"
openapi: "POST /api/v3/pki/certificates/{certificateId}/renew" openapi: "POST /api/v1/cert-manager/certificates/{id}/renew"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Revoke" title: "Revoke"
openapi: "POST /api/v1/pki/certificates/{serialNumber}/revoke" openapi: "POST /api/v1/cert-manager/certificates/{id}/revoke"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Sign Certificate" title: "Sign Certificate"
openapi: "POST /api/v3/pki/certificates/sign-certificate" openapi: "POST /api/v1/cert-manager/certificates/sign-certificate"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Update Certificate Config" title: "Update Certificate Config"
openapi: "PATCH /api/v3/pki/certificates/{certificateId}/config" openapi: "PATCH /api/v1/cert-manager/certificates/{id}/config"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Add Certificates to Sync" title: "Add Certificates to Sync"
openapi: "POST /api/v1/pki/syncs/{pkiSyncId}/certificates" openapi: "POST /api/v1/cert-manager/syncs/{pkiSyncId}/certificates"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Create AWS Certificate Manager PKI Sync" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Delete AWS Certificate Manager PKI Sync" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get AWS Certificate Manager PKI Sync by ID" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List AWS Certificate Manager PKI Syncs" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Remove Certificates from AWS Certificate Manager" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Sync Certificates to AWS Certificate Manager" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Update AWS Certificate Manager PKI Sync" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Create AWS Secrets Manager PKI Sync" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Delete AWS Secrets Manager PKI Sync" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get AWS Secrets Manager PKI Sync by ID" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List AWS Secrets Manager PKI Syncs" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Remove Certificates from AWS Secrets Manager" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Sync Certificates to AWS Secrets Manager" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Update AWS Secrets Manager PKI Sync" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Create Azure Key Vault PKI Sync" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Delete Azure Key Vault PKI Sync" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get Azure Key Vault PKI Sync by ID" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List Azure Key Vault PKI Syncs" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Remove Certificates from Azure Key Vault" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Sync Certificates to Azure Key Vault" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Update Azure Key Vault PKI Sync" 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}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Create Chef PKI Sync" title: "Create Chef PKI Sync"
openapi: "POST /api/v1/pki/syncs/chef" openapi: "POST /api/v1/cert-manager/syncs/chef"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Delete Chef PKI Sync" title: "Delete Chef PKI Sync"
openapi: "DELETE /api/v1/pki/syncs/chef/{pkiSyncId}" openapi: "DELETE /api/v1/cert-manager/syncs/chef/{pkiSyncId}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get Chef PKI Sync by ID" title: "Get Chef PKI Sync by ID"
openapi: "GET /api/v1/pki/syncs/chef/{pkiSyncId}" openapi: "GET /api/v1/cert-manager/syncs/chef/{pkiSyncId}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List Chef PKI Syncs" title: "List Chef PKI Syncs"
openapi: "GET /api/v1/pki/syncs/chef" openapi: "GET /api/v1/cert-manager/syncs/chef"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Remove Certificates from Chef" 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"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Sync Certificates to Chef" title: "Sync Certificates to Chef"
openapi: "POST /api/v1/pki/syncs/chef/{pkiSyncId}/sync" openapi: "POST /api/v1/cert-manager/syncs/chef/{pkiSyncId}/sync"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Update Chef PKI Sync" title: "Update Chef PKI Sync"
openapi: "PATCH /api/v1/pki/syncs/chef/{pkiSyncId}" openapi: "PATCH /api/v1/cert-manager/syncs/chef/{pkiSyncId}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Get PKI Sync by ID" title: "Get PKI Sync by ID"
openapi: "GET /api/v1/pki/syncs/{pkiSyncId}" openapi: "GET /api/v1/cert-manager/syncs/{pkiSyncId}"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List Sync Certificates" title: "List Sync Certificates"
openapi: "GET /api/v1/pki/syncs/{pkiSyncId}/certificates" openapi: "GET /api/v1/cert-manager/syncs/{pkiSyncId}/certificates"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List PKI Syncs" title: "List PKI Syncs"
openapi: "GET /api/v1/pki/syncs" openapi: "GET /api/v1/cert-manager/syncs"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "List PKI Sync Options" title: "List PKI Sync Options"
openapi: "GET /api/v1/pki/syncs/options" openapi: "GET /api/v1/cert-manager/syncs/options"
--- ---
@@ -1,4 +1,4 @@
--- ---
title: "Remove Certificates from Sync" title: "Remove Certificates from Sync"
openapi: "DELETE /api/v1/pki/syncs/{pkiSyncId}/certificates" openapi: "DELETE /api/v1/cert-manager/syncs/{pkiSyncId}/certificates"
--- ---
+14 -31
View File
@@ -2530,21 +2530,16 @@
"api-reference/endpoints/certificate-authorities/internal/create", "api-reference/endpoints/certificate-authorities/internal/create",
"api-reference/endpoints/certificate-authorities/internal/read", "api-reference/endpoints/certificate-authorities/internal/read",
"api-reference/endpoints/certificate-authorities/internal/update", "api-reference/endpoints/certificate-authorities/internal/update",
"api-reference/endpoints/certificate-authorities/internal/delete" "api-reference/endpoints/certificate-authorities/internal/delete",
"api-reference/endpoints/certificate-authorities/internal/renew",
"api-reference/endpoints/certificate-authorities/internal/list-ca-certs",
"api-reference/endpoints/certificate-authorities/internal/csr",
"api-reference/endpoints/certificate-authorities/internal/cert",
"api-reference/endpoints/certificate-authorities/internal/sign-intermediate",
"api-reference/endpoints/certificate-authorities/internal/import-cert",
"api-reference/endpoints/certificate-authorities/internal/crl"
] ]
}, }
"api-reference/endpoints/certificate-authorities/list",
"api-reference/endpoints/certificate-authorities/create",
"api-reference/endpoints/certificate-authorities/read",
"api-reference/endpoints/certificate-authorities/update",
"api-reference/endpoints/certificate-authorities/delete",
"api-reference/endpoints/certificate-authorities/renew",
"api-reference/endpoints/certificate-authorities/list-ca-certs",
"api-reference/endpoints/certificate-authorities/csr",
"api-reference/endpoints/certificate-authorities/cert",
"api-reference/endpoints/certificate-authorities/sign-intermediate",
"api-reference/endpoints/certificate-authorities/import-cert",
"api-reference/endpoints/certificate-authorities/crl"
] ]
}, },
{ {
@@ -2566,23 +2561,11 @@
{ {
"group": "Certificate Templates", "group": "Certificate Templates",
"pages": [ "pages": [
"api-reference/endpoints/certificate-templates-v2/list", "api-reference/endpoints/certificate-templates/list",
"api-reference/endpoints/certificate-templates-v2/create", "api-reference/endpoints/certificate-templates/create",
"api-reference/endpoints/certificate-templates-v2/update", "api-reference/endpoints/certificate-templates/update",
"api-reference/endpoints/certificate-templates-v2/get-by-id", "api-reference/endpoints/certificate-templates/get-by-id",
"api-reference/endpoints/certificate-templates-v2/delete" "api-reference/endpoints/certificate-templates/delete"
]
},
{
"group": "Certificate Collections",
"pages": [
"api-reference/endpoints/pki-collections/create",
"api-reference/endpoints/pki-collections/read",
"api-reference/endpoints/pki-collections/update",
"api-reference/endpoints/pki-collections/delete",
"api-reference/endpoints/pki-collections/add-item",
"api-reference/endpoints/pki-collections/list-items",
"api-reference/endpoints/pki-collections/delete-item"
] ]
}, },
{ {
@@ -153,7 +153,7 @@ In the following steps, we explore how to connect Infisical to an ACME-compatibl
### Sample request ### Sample request
```bash Request ```bash Request
curl 'https://app.infisical.com/api/v1/pki/ca/acme' \ curl 'https://app.infisical.com/api/v1/cert-manager/ca/acme' \
-H 'Authorization: Bearer <your-access-token>' \ -H 'Authorization: Bearer <your-access-token>' \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
@@ -122,7 +122,7 @@ consisting of an (optional) root CA and an intermediate CA.
### Sample request ### Sample request
```bash Request ```bash Request
curl --location --request POST 'https://app.infisical.com/api/v1/pki/ca' \ curl --location --request POST 'https://app.infisical.com/api/v1/cert-manager/ca/internal' \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
@@ -155,7 +155,7 @@ consisting of an (optional) root CA and an intermediate CA.
### Sample request ### Sample request
```bash Request ```bash Request
curl --location --request POST 'https://app.infisical.com/api/v1/pki/ca' \ curl --location --request POST 'https://app.infisical.com/api/v1/cert-manager/ca/internal' \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
@@ -183,7 +183,7 @@ consisting of an (optional) root CA and an intermediate CA.
### Sample request ### Sample request
```bash Request ```bash Request
curl --location --request GET 'https://app.infisical.com/api/v1/pki/ca/<intermediate-ca-id>/csr' \ curl --location --request GET 'https://app.infisical.com/api/v1/cert-manager/ca/internal/<intermediate-ca-id>/csr' \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--data-raw '' --data-raw ''
``` ```
@@ -204,7 +204,7 @@ consisting of an (optional) root CA and an intermediate CA.
### Sample request ### Sample request
```bash Request ```bash Request
curl --location --request POST 'https://app.infisical.com/api/v1/pki/ca/<root-ca-id>/sign-intermediate' \ curl --location --request POST 'https://app.infisical.com/api/v1/cert-manager/ca/internal/<root-ca-id>/sign-intermediate' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"csr": "<csr>", "csr": "<csr>",
@@ -234,7 +234,7 @@ consisting of an (optional) root CA and an intermediate CA.
### Sample request ### Sample request
```bash Request ```bash Request
curl --location --request POST 'https://app.infisical.com/api/v1/pki/ca/<intermediate-ca-id>/import-certificate' \ curl --location --request POST 'https://app.infisical.com/api/v1/cert-manager/ca/internal/<intermediate-ca-id>/import-certificate' \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
@@ -292,7 +292,7 @@ the certificate back to the intermediate CA.
### Sample request ### Sample request
```bash Request ```bash Request
curl --location --request POST 'https://app.infisical.com/api/v1/pki/ca/<ca-id>/renew' \ curl --location --request POST 'https://app.infisical.com/api/v1/cert-manager/ca/internal/<ca-id>/renew' \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
@@ -70,7 +70,7 @@ These permissions allow Infisical to list, import, tag, and manage certificates
```bash Request ```bash Request
curl --request POST \ curl --request POST \
--url https://app.infisical.com/api/v1/pki/syncs/aws-certificate-manager \ --url https://app.infisical.com/api/v1/cert-manager/syncs/aws-certificate-manager \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data '{ --data '{
@@ -102,7 +102,7 @@ Any role with these permissions would work such as a custom policy with **Secret
```bash Request ```bash Request
curl --request POST \ curl --request POST \
--url https://app.infisical.com/api/v1/pki/syncs/aws-secrets-manager \ --url https://app.infisical.com/api/v1/cert-manager/syncs/aws-secrets-manager \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data '{ --data '{
@@ -140,7 +140,7 @@ Any role with these permissions would work such as a custom policy with **Secret
```bash Request ```bash Request
curl --request POST \ curl --request POST \
--url https://app.infisical.com/api/v1/pki/syncs/aws-secrets-manager \ --url https://app.infisical.com/api/v1/cert-manager/syncs/aws-secrets-manager \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data '{ --data '{
@@ -77,7 +77,7 @@ Any role with these permissions would work such as the **Key Vault Certificates
```bash Request ```bash Request
curl --request POST \ curl --request POST \
--url https://app.infisical.com/api/v1/pki/syncs/azure-key-vault \ --url https://app.infisical.com/api/v1/cert-manager/syncs/azure-key-vault \
--header 'Authorization: Bearer <access-token>' \ --header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data '{ --data '{

Some files were not shown because too many files have changed in this diff Show More