openapi: 3.0.3 info: title: Infisical Admin PKI Certificate Authorities API description: List of all available APIs that can be consumed version: 0.0.1 servers: - url: https://us.infisical.com description: Production server (US) - url: https://eu.infisical.com description: Production server (EU) - url: http://localhost:8080 description: Local server tags: - name: PKI Certificate Authorities paths: /api/v1/projects/{projectId}/cas: get: operationId: listProjectCertificateAuthorities tags: - PKI Certificate Authorities parameters: - schema: type: string enum: - active - pending-certificate in: query name: status required: false description: The status of the CA to filter by. - schema: type: string in: query name: friendlyName required: false description: The friendly name of the CA to filter by. - schema: type: string in: query name: commonName required: false description: The common name of the CA to filter by. - schema: type: number minimum: 0 maximum: 100 default: 0 in: query name: offset required: false description: The offset to start from. If you enter 10, it will start from the 10th CA. - schema: type: number minimum: 1 maximum: 100 default: 25 in: query name: limit required: false description: The number of CAs to return. - schema: type: string in: path name: projectId required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: cas: type: array items: type: object properties: id: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time projectId: type: string status: type: string enableDirectIssuance: type: boolean default: true name: type: string parentCaId: type: string format: uuid nullable: true type: type: string friendlyName: type: string organization: type: string ou: type: string country: type: string province: type: string locality: type: string commonName: type: string dn: type: string serialNumber: type: string nullable: true maxPathLength: type: number nullable: true keyAlgorithm: type: string activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string nullable: true disableManagedCrlDistributionPointUrl: type: boolean default: false requireTemplateForIssuance: type: boolean notAfter: type: string notBefore: type: string required: - id - createdAt - updatedAt - projectId - status - name - type - friendlyName - organization - ou - country - province - locality - commonName - dn - keyAlgorithm additionalProperties: false required: - cas additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal: get: operationId: listInternalCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createInternalCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Internal Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the Internal Certificate Authority. configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{id}: get: operationId: getInternalCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateInternalCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Internal Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the Internal Certificate Authority. configuration: type: object properties: crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteInternalCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/csr: get: operationId: getCaCsr tags: - PKI Certificate Authorities description: Get CA CSR parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to generate CSR from. responses: '200': description: Default Response content: application/json: schema: type: object properties: csr: type: string description: The generated CSR from the CA. required: - csr additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/renew: post: operationId: renewCaCertificate tags: - PKI Certificate Authorities description: Perform CA certificate renewal requestBody: required: true content: application/json: schema: type: object properties: type: type: string enum: - existing description: The type of behavior to use for the renewal operation. Currently Infisical is only able to renew a CA certificate with the same key pair. notAfter: type: string description: The expiry date and time for the renewed CA certificate in YYYY-MM-DDTHH:mm:ss.sssZ format. required: - type - notAfter additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to renew the CA certificate for. responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The renewed CA certificate body. certificateChain: type: string description: The certificate chain of the CA. serialNumber: type: string description: The serial number of the renewed CA certificate. certId: type: string description: Certificate ID required: - certificate - certificateChain - serialNumber - certId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/certificate: post: tags: - PKI Certificate Authorities description: Generate certificate for a Certificate Authority requestBody: required: true content: application/json: schema: type: object properties: notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 default: -1 description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. parentCaId: type: string description: Parent CA ID for intermediate certificate generation required: - notBefore - notAfter additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to generate a certificate for. responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The generated CA certificate. certificateChain: type: string description: The certificate chain of the CA. serialNumber: type: string description: The serial number of the CA certificate. certId: type: string description: Certificate ID required: - certificate - certificateChain - serialNumber - certId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false get: operationId: getCaCertificate tags: - PKI Certificate Authorities description: Get current CA cert and cert chain of a CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the certificate body and certificate chain from. responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The certificate body of the CA. certificateChain: type: string description: The certificate chain of the CA. serialNumber: type: string description: The serial number of the CA certificate. certId: type: string description: Certificate ID required: - certificate - certificateChain - serialNumber - certId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/ca-certificates: get: operationId: getCaCertificates tags: - PKI Certificate Authorities description: Get list of past and current CA certificates for a CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the CA certificates for. responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: certificate: type: string description: The certificate body of the CA certificate. certificateChain: type: string description: The certificate chain of the CA certificate. serialNumber: type: string description: The serial number of the CA certificate. certId: type: string description: Certificate ID version: type: number description: The version of the CA certificate. The version is incremented for each CA renewal operation. required: - certificate - certificateChain - serialNumber - certId - version additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/certificate/{certId}: get: tags: - PKI Certificate Authorities description: Get a specific CA certificate by ID parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the certificate body and certificate chain from. - schema: type: string in: path name: certId required: true description: Certificate ID to retrieve responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The certificate body of the CA. certificateChain: type: string description: The certificate chain of the CA. serialNumber: type: string description: The serial number of the CA certificate. certId: type: string description: Certificate ID notBefore: type: string notAfter: type: string maxPathLength: type: number parentCaId: type: string format: uuid required: - certificate - certificateChain - serialNumber - certId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/sign-intermediate: post: operationId: signIntermediateCa tags: - PKI Certificate Authorities description: Create intermediate CA certificate from parent CA requestBody: required: true content: application/json: schema: type: object properties: csr: type: string minLength: 1 description: The pem-encoded CSR to sign with the CA. notBefore: type: string description: The date and time when the intermediate CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the intermediate CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 default: -1 description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. required: - csr - notAfter additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to sign the intermediate certificate with. responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The signed intermediate certificate. certificateChain: type: string description: The certificate chain of the intermediate certificate. issuingCaCertificate: type: string description: The certificate of the issuing CA. serialNumber: type: string description: The serial number of the intermediate certificate. required: - certificate - certificateChain - issuingCaCertificate - serialNumber additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/import-certificate: post: operationId: importCaCertificate tags: - PKI Certificate Authorities description: Import certificate and chain to CA requestBody: required: true content: application/json: schema: type: object properties: certificate: type: string description: The certificate body to import. certificateChain: type: string description: The certificate chain to import. required: - certificate - certificateChain additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to import the certificate for. responses: '200': description: Default Response content: application/json: schema: type: object properties: message: type: string caId: type: string required: - message - caId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/crls: get: operationId: getCaCrls tags: - PKI Certificate Authorities description: Get list of CRLs of the CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the certificate revocation lists (CRLs) for. responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: id: type: string description: The ID of certificate revocation list (CRL). crl: type: string description: The certificate revocation list (CRL). required: - id - crl additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/certificates/{caCertId}/der: get: operationId: getCaCertificateDer tags: - PKI Certificate Authorities description: Get DER-encoded certificate of CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the CA certificate from. - schema: type: string in: path name: caCertId required: true description: The ID of the CA certificate to get. responses: '200': description: Default Response content: application/json: schema: {} '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/install-certificate-venafi: post: operationId: installCaCertificateVenafi tags: - PKI Certificate Authorities description: Install a CA certificate via Venafi TLS Protect Cloud requestBody: required: true content: application/json: schema: type: object properties: maxPathLength: type: number minimum: -1 default: -1 additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to install the certificate for via Venafi. responses: '202': description: Default Response content: application/json: schema: type: object properties: message: type: string caId: type: string required: - message - caId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/install-certificate-adcs: post: operationId: installCaCertificateAdcs tags: - PKI Certificate Authorities description: Install a CA certificate via Azure AD CS requestBody: required: true content: application/json: schema: type: object properties: maxPathLength: type: number minimum: -1 default: -1 additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to install the certificate for via Azure AD CS. responses: '202': description: Default Response content: application/json: schema: type: object properties: message: type: string caId: type: string required: - message - caId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/signing-config: post: operationId: createCaSigningConfig tags: - PKI Certificate Authorities description: Create a signing configuration for a CA requestBody: required: true content: application/json: schema: anyOf: - type: object properties: type: type: string enum: - internal parentCaId: type: string format: uuid required: - type additionalProperties: false - type: object properties: type: type: string enum: - manual required: - type additionalProperties: false - type: object properties: type: type: string enum: - venafi appConnectionId: type: string format: uuid destinationConfig: type: object properties: applicationId: type: string format: uuid issuingTemplateId: type: string format: uuid validityPeriod: type: integer exclusiveMinimum: true minimum: 0 required: - applicationId - issuingTemplateId additionalProperties: false required: - type - appConnectionId - destinationConfig additionalProperties: false - type: object properties: type: type: string enum: - azure-ad-cs appConnectionId: type: string format: uuid destinationConfig: type: object properties: template: type: string minLength: 1 validityPeriod: type: integer exclusiveMinimum: true minimum: 0 required: - template additionalProperties: false required: - type - appConnectionId - destinationConfig additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to create a signing configuration for. responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid caId: type: string format: uuid type: type: string parentCaId: type: string format: uuid nullable: true appConnectionId: type: string format: uuid nullable: true destinationConfig: nullable: true lastExternalCertificateId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - caId - type - createdAt - updatedAt additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false get: operationId: getCaSigningConfig tags: - PKI Certificate Authorities description: Get the signing configuration for a CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the signing configuration for. responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid caId: type: string format: uuid type: type: string parentCaId: type: string format: uuid nullable: true appConnectionId: type: string format: uuid nullable: true destinationConfig: nullable: true lastExternalCertificateId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - caId - type - createdAt - updatedAt additionalProperties: false nullable: true '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateCaSigningConfig tags: - PKI Certificate Authorities description: Update the signing configuration for a CA requestBody: required: true content: application/json: schema: type: object properties: parentCaId: type: string format: uuid appConnectionId: type: string format: uuid destinationConfig: anyOf: - type: object properties: applicationId: type: string format: uuid issuingTemplateId: type: string format: uuid validityPeriod: type: integer exclusiveMinimum: true minimum: 0 required: - applicationId - issuingTemplateId additionalProperties: false - type: object properties: template: type: string minLength: 1 validityPeriod: type: integer exclusiveMinimum: true minimum: 0 required: - template additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to update the signing configuration for. responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid caId: type: string format: uuid type: type: string parentCaId: type: string format: uuid nullable: true appConnectionId: type: string format: uuid nullable: true destinationConfig: nullable: true lastExternalCertificateId: type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - caId - type - createdAt - updatedAt additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/internal/{caId}/auto-renewal: get: operationId: getCaAutoRenewalConfig tags: - PKI Certificate Authorities description: Get auto-renewal configuration for a CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the auto-renewal configuration for. responses: '200': description: Default Response content: application/json: schema: type: object properties: autoRenewalEnabled: type: boolean autoRenewalDaysBeforeExpiry: type: number nullable: true lastRenewalStatus: type: string nullable: true lastRenewalMessage: type: string nullable: true lastRenewalAt: type: string format: date-time nullable: true required: - autoRenewalEnabled - autoRenewalDaysBeforeExpiry - lastRenewalStatus - lastRenewalMessage - lastRenewalAt additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateCaAutoRenewalConfig tags: - PKI Certificate Authorities description: Update auto-renewal configuration for a CA requestBody: required: true content: application/json: schema: type: object properties: autoRenewalEnabled: type: boolean autoRenewalDaysBeforeExpiry: type: number minimum: 1 maximum: 365 additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to update the auto-renewal configuration for. responses: '200': description: Default Response content: application/json: schema: type: object properties: autoRenewalEnabled: type: boolean autoRenewalDaysBeforeExpiry: type: number nullable: true lastRenewalStatus: type: string nullable: true lastRenewalMessage: type: string nullable: true lastRenewalAt: type: string format: date-time nullable: true required: - autoRenewalEnabled - autoRenewalDaysBeforeExpiry - lastRenewalStatus - lastRenewalMessage - lastRenewalAt additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/acme: get: operationId: listAcmeCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAcmeCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the ACME-compatible CA Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the ACME-compatible CA Certificate Authority. configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. eabHmacKey: type: string maxLength: 512 description: The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/acme/{id}: get: operationId: getAcmeCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAcmeCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the ACME-compatible CA Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the ACME-compatible CA Certificate Authority. configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. eabHmacKey: type: string maxLength: 512 description: The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAcmeCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/azure-ad-cs: get: operationId: listAzureAdCsCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAzureAdCsCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Active Directory Certificate Service Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the Active Directory Certificate Service Certificate Authority. configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/azure-ad-cs/{id}: get: operationId: getAzureAdCsCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAzureAdCsCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Active Directory Certificate Service Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the Active Directory Certificate Service Certificate Authority. configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAzureAdCsCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/aws-pca: get: operationId: listAwsPcaCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-pca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAwsPcaCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the AWS Private Certificate Authority Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the AWS Private Certificate Authority Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-pca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/aws-pca/{id}: get: operationId: getAwsPcaCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-pca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAwsPcaCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the AWS Private Certificate Authority Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the AWS Private Certificate Authority Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-pca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAwsPcaCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-pca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/digicert: get: operationId: listDigicertCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - digicert configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createDigicertCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the DigiCert Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the DigiCert Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - digicert configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/digicert/{id}: get: operationId: getDigicertCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - digicert configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateDigicertCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the DigiCert Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the DigiCert Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - digicert configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteDigicertCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - digicert configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/godaddy: get: operationId: listGodaddyCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - godaddy configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createGodaddyCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the GoDaddy Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the GoDaddy Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - godaddy configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/godaddy/{id}: get: operationId: getGodaddyCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - godaddy configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateGodaddyCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the GoDaddy Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the GoDaddy Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - godaddy configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteGodaddyCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - godaddy configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/aws-acm-public-ca: get: operationId: listAwsAcmPublicCaCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-acm-public-ca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAwsAcmPublicCaCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the AWS ACM Public CA Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the AWS ACM Public CA Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-acm-public-ca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/aws-acm-public-ca/{id}: get: operationId: getAwsAcmPublicCaCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-acm-public-ca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAwsAcmPublicCaCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the AWS ACM Public CA Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the AWS ACM Public CA Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-acm-public-ca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAwsAcmPublicCaCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-acm-public-ca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/venafi-tpp: get: operationId: listVenafiTppCertificateAuthoritiesV1 tags: - PKI Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - venafi-tpp configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createVenafiTppCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Venafi Trust Protection Platform Certificate Authority to create. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The status of the Venafi Trust Protection Platform Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - name - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - venafi-tpp configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca/venafi-tpp/{id}: get: operationId: getVenafiTppCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - venafi-tpp configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateVenafiTppCertificateAuthorityV1 tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Venafi Trust Protection Platform Certificate Authority. Must be slug-friendly. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the Venafi Trust Protection Platform Certificate Authority. configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false additionalProperties: false parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - venafi-tpp configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteVenafiTppCertificateAuthorityV1 tags: - PKI Certificate Authorities parameters: - schema: type: string in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - venafi-tpp configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/cert-manager/ca: get: operationId: listCertificateAuthoritiesV1General tags: - PKI Certificate Authorities description: Get Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: object properties: certificateAuthorities: type: array items: anyOf: - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-pca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - digicert configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - godaddy configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-acm-public-ca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false - type: object properties: enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - venafi-tpp configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - name - id - status - type - configuration additionalProperties: false required: - certificateAuthorities additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca: post: operationId: createCertificateAuthorityV1 tags: - PKI Certificate Authorities description: Create CA requestBody: required: true content: application/json: schema: type: object properties: projectSlug: type: string description: Slug of the project to create the CA in. type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string description: The common name (CN) for the CA. organization: type: string description: The organization (O) for the CA. ou: type: string description: The organization unit (OU) for the CA. country: type: string description: The country name (C) for the CA. province: type: string description: The state of province name for the CA. locality: type: string description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 default: -1 description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s default: RSA_2048 description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. requireTemplateForIssuance: type: boolean default: false description: Whether or not certificates for this CA can only be issued through certificate templates. required: - projectSlug - type - commonName - organization - ou - country - province - locality additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: ca: type: object properties: id: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time projectId: type: string status: type: string enableDirectIssuance: type: boolean default: true name: type: string parentCaId: type: string format: uuid nullable: true type: type: string friendlyName: type: string organization: type: string ou: type: string country: type: string province: type: string locality: type: string commonName: type: string dn: type: string serialNumber: type: string nullable: true maxPathLength: type: number nullable: true keyAlgorithm: type: string activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string nullable: true disableManagedCrlDistributionPointUrl: type: boolean default: false requireTemplateForIssuance: type: boolean notAfter: type: string notBefore: type: string required: - id - createdAt - updatedAt - projectId - status - name - type - friendlyName - organization - ou - country - province - locality - commonName - dn - keyAlgorithm additionalProperties: false required: - ca additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}: get: operationId: getCertificateAuthorityV1 tags: - PKI Certificate Authorities description: Get CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get. responses: '200': description: Default Response content: application/json: schema: type: object properties: ca: type: object properties: id: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time projectId: type: string status: type: string enableDirectIssuance: type: boolean default: true name: type: string parentCaId: type: string format: uuid nullable: true type: type: string friendlyName: type: string organization: type: string ou: type: string country: type: string province: type: string locality: type: string commonName: type: string dn: type: string serialNumber: type: string nullable: true maxPathLength: type: number nullable: true keyAlgorithm: type: string activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string nullable: true disableManagedCrlDistributionPointUrl: type: boolean default: false requireTemplateForIssuance: type: boolean notAfter: type: string notBefore: type: string required: - id - createdAt - updatedAt - projectId - status - name - type - friendlyName - organization - ou - country - province - locality - commonName - dn - keyAlgorithm additionalProperties: false required: - ca additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateCertificateAuthorityV1 tags: - PKI Certificate Authorities description: Update CA requestBody: required: true content: application/json: schema: type: object properties: status: type: string enum: - active - disabled description: The status of the CA to update to. This can be one of active or disabled. requireTemplateForIssuance: type: boolean description: Whether or not certificates for this CA can only be issued through certificate templates. additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to update. responses: '200': description: Default Response content: application/json: schema: type: object properties: ca: type: object properties: id: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time projectId: type: string status: type: string enableDirectIssuance: type: boolean default: true name: type: string parentCaId: type: string format: uuid nullable: true type: type: string friendlyName: type: string organization: type: string ou: type: string country: type: string province: type: string locality: type: string commonName: type: string dn: type: string serialNumber: type: string nullable: true maxPathLength: type: number nullable: true keyAlgorithm: type: string activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string nullable: true disableManagedCrlDistributionPointUrl: type: boolean default: false requireTemplateForIssuance: type: boolean notAfter: type: string notBefore: type: string required: - id - createdAt - updatedAt - projectId - status - name - type - friendlyName - organization - ou - country - province - locality - commonName - dn - keyAlgorithm additionalProperties: false required: - ca additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteCertificateAuthorityV1 tags: - PKI Certificate Authorities description: Delete CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to delete. responses: '200': description: Default Response content: application/json: schema: type: object properties: ca: type: object properties: id: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time projectId: type: string status: type: string enableDirectIssuance: type: boolean default: true name: type: string parentCaId: type: string format: uuid nullable: true type: type: string friendlyName: type: string organization: type: string ou: type: string country: type: string province: type: string locality: type: string commonName: type: string dn: type: string serialNumber: type: string nullable: true maxPathLength: type: number nullable: true keyAlgorithm: type: string activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string nullable: true disableManagedCrlDistributionPointUrl: type: boolean default: false requireTemplateForIssuance: type: boolean notAfter: type: string notBefore: type: string required: - id - createdAt - updatedAt - projectId - status - name - type - friendlyName - organization - ou - country - province - locality - commonName - dn - keyAlgorithm additionalProperties: false required: - ca additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}/certificates/{caCertId}/der: get: operationId: getCertificateAuthorityDerCertificate tags: - PKI Certificate Authorities description: Get DER-encoded certificate of CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the CA certificate from. - schema: type: string in: path name: caCertId required: true description: The ID of the CA certificate to get. responses: '200': description: Default Response content: application/json: schema: {} '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}/csr: get: operationId: getCertificateAuthorityCsr tags: - PKI Certificate Authorities description: Get CA CSR parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to generate CSR from. responses: '200': description: Default Response content: application/json: schema: type: object properties: csr: type: string description: The generated CSR from the CA. required: - csr additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}/renew: post: operationId: renewCertificateAuthority tags: - PKI Certificate Authorities description: Perform CA certificate renewal requestBody: required: true content: application/json: schema: type: object properties: type: type: string enum: - existing description: The type of behavior to use for the renewal operation. Currently Infisical is only able to renew a CA certificate with the same key pair. notAfter: type: string description: The expiry date and time for the renewed CA certificate in YYYY-MM-DDTHH:mm:ss.sssZ format. required: - type - notAfter additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to renew the CA certificate for. responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The renewed CA certificate body. certificateChain: type: string description: The certificate chain of the CA. serialNumber: type: string description: The serial number of the renewed CA certificate. required: - certificate - certificateChain - serialNumber additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}/ca-certificates: get: operationId: listCertificateAuthorityCertificates tags: - PKI Certificate Authorities description: Get list of past and current CA certificates for a CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the CA certificates for. responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: certificate: type: string description: The certificate body of the CA certificate. certificateChain: type: string description: The certificate chain of the CA certificate. serialNumber: type: string description: The serial number of the CA certificate. version: type: number description: The version of the CA certificate. The version is incremented for each CA renewal operation. required: - certificate - certificateChain - serialNumber - version additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}/certificate: get: operationId: getCertificateAuthorityCertificate tags: - PKI Certificate Authorities description: Get current CA cert and cert chain of a CA parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to get the certificate body and certificate chain from. responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The certificate body of the CA. certificateChain: type: string description: The certificate chain of the CA. serialNumber: type: string description: The serial number of the CA certificate. required: - certificate - certificateChain - serialNumber additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}/sign-intermediate: post: operationId: signIntermediateCertificateAuthority tags: - PKI Certificate Authorities description: Create intermediate CA certificate from parent CA requestBody: required: true content: application/json: schema: type: object properties: csr: type: string minLength: 1 description: The pem-encoded CSR to sign with the CA. notBefore: type: string description: The date and time when the intermediate CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the intermediate CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 default: -1 description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. required: - csr - notAfter additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to sign the intermediate certificate with. responses: '200': description: Default Response content: application/json: schema: type: object properties: certificate: type: string description: The signed intermediate certificate. certificateChain: type: string description: The certificate chain of the intermediate certificate. issuingCaCertificate: type: string description: The certificate of the issuing CA. serialNumber: type: string description: The serial number of the intermediate certificate. required: - certificate - certificateChain - issuingCaCertificate - serialNumber additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/{caId}/import-certificate: post: operationId: importCertificateAuthorityCertificate tags: - PKI Certificate Authorities description: Import certificate and chain to CA requestBody: required: true content: application/json: schema: type: object properties: certificate: type: string description: The certificate body to import. certificateChain: type: string description: The certificate chain to import. required: - certificate - certificateChain additionalProperties: false parameters: - schema: type: string in: path name: caId required: true description: The ID of the CA to import the certificate for. responses: '200': description: Default Response content: application/json: schema: type: object properties: message: type: string caId: type: string required: - message - caId additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/internal: get: tags: - PKI Certificate Authorities parameters: - schema: type: string minLength: 1 in: query name: projectId required: true responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Internal Certificate Authority to create. Must be slug-friendly. projectId: type: string format: uuid description: The ID of the project to create the Certificate Authority in. enableDirectIssuance: type: boolean description: Whether or not to enable direct issuance of certificates for the Internal Certificate Authority. status: type: string enum: - active - disabled - pending-certificate description: The status of the Internal Certificate Authority. configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - name - projectId - enableDirectIssuance - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/internal/{caName}: get: tags: - PKI Certificate Authorities parameters: - schema: type: string format: uuid in: query name: projectId required: true - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Internal Certificate Authority. Must be slug-friendly. projectId: type: string format: uuid description: The ID of the project to update the Certificate Authority in. enableDirectIssuance: type: boolean description: Whether or not to enable direct issuance of certificates for the Internal Certificate Authority. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the Internal Certificate Authority. required: - projectId additionalProperties: false parameters: - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: projectId: type: string format: uuid required: - projectId additionalProperties: false parameters: - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/acme: get: tags: - PKI Certificate Authorities parameters: - schema: type: string minLength: 1 in: query name: projectId required: true responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the ACME-compatible CA Certificate Authority to create. Must be slug-friendly. projectId: type: string format: uuid description: The ID of the project to create the Certificate Authority in. enableDirectIssuance: type: boolean description: Whether or not to enable direct issuance of certificates for the ACME-compatible CA Certificate Authority. status: type: string enum: - active - disabled - pending-certificate description: The status of the ACME-compatible CA Certificate Authority. configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. eabHmacKey: type: string maxLength: 512 description: The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - name - projectId - enableDirectIssuance - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/acme/{caName}: get: tags: - PKI Certificate Authorities parameters: - schema: type: string format: uuid in: query name: projectId required: true - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the ACME-compatible CA Certificate Authority. Must be slug-friendly. projectId: type: string format: uuid description: The ID of the project to update the Certificate Authority in. enableDirectIssuance: type: boolean description: Whether or not to enable direct issuance of certificates for the ACME-compatible CA Certificate Authority. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the ACME-compatible CA Certificate Authority. configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. eabHmacKey: type: string maxLength: 512 description: The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - projectId additionalProperties: false parameters: - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: projectId: type: string format: uuid required: - projectId additionalProperties: false parameters: - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/azure-ad-cs: get: tags: - PKI Certificate Authorities parameters: - schema: type: string minLength: 1 in: query name: projectId required: true responses: '200': description: Default Response content: application/json: schema: type: array items: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the Active Directory Certificate Service Certificate Authority to create. Must be slug-friendly. projectId: type: string format: uuid description: The ID of the project to create the Certificate Authority in. enableDirectIssuance: type: boolean description: Whether or not to enable direct issuance of certificates for the Active Directory Certificate Service Certificate Authority. status: type: string enum: - active - disabled - pending-certificate description: The status of the Active Directory Certificate Service Certificate Authority. configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - name - projectId - enableDirectIssuance - status - configuration additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/pki/ca/azure-ad-cs/{caName}: get: tags: - PKI Certificate Authorities parameters: - schema: type: string format: uuid in: query name: projectId required: true - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the Active Directory Certificate Service Certificate Authority. Must be slug-friendly. projectId: type: string format: uuid description: The ID of the project to update the Certificate Authority in. enableDirectIssuance: type: boolean description: Whether or not to enable direct issuance of certificates for the Active Directory Certificate Service Certificate Authority. status: type: string enum: - active - disabled - pending-certificate description: The updated status of the Active Directory Certificate Service Certificate Authority. configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - projectId additionalProperties: false parameters: - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: tags: - PKI Certificate Authorities requestBody: required: true content: application/json: schema: type: object properties: projectId: type: string format: uuid required: - projectId additionalProperties: false parameters: - schema: type: string in: path name: caName required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v2/pki/ca: get: operationId: listCertificateAuthoritiesV2 tags: - PKI Certificate Authorities description: Get Certificate Authorities responses: '200': description: Default Response content: application/json: schema: type: object properties: certificateAuthorities: type: array items: anyOf: - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - internal configuration: type: object properties: type: type: string enum: - root - intermediate description: The type of CA to create. friendlyName: type: string description: A friendly name for the CA. commonName: type: string default: '' description: The common name (CN) for the CA. organization: type: string default: '' description: The organization (O) for the CA. ou: type: string default: '' description: The organization unit (OU) for the CA. country: type: string default: '' description: The country name (C) for the CA. province: type: string default: '' description: The state of province name for the CA. locality: type: string default: '' description: The locality name for the CA. notBefore: type: string description: The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format. notAfter: type: string description: The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format. maxPathLength: type: number minimum: -1 nullable: true description: The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain. keyAlgorithm: type: string enum: - RSA_2048 - RSA_3072 - RSA_4096 - EC_prime256v1 - EC_secp384r1 - EC_secp521r1 - ML-DSA-44 - ML-DSA-65 - ML-DSA-87 - SLH-DSA-SHA2-128f - SLH-DSA-SHA2-128s - SLH-DSA-SHA2-192f - SLH-DSA-SHA2-192s - SLH-DSA-SHA2-256f - SLH-DSA-SHA2-256s - SLH-DSA-SHAKE-128f - SLH-DSA-SHAKE-128s - SLH-DSA-SHAKE-192f - SLH-DSA-SHAKE-192s - SLH-DSA-SHAKE-256f - SLH-DSA-SHAKE-256s description: The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA. dn: type: string nullable: true parentCaId: type: string format: uuid nullable: true serialNumber: type: string nullable: true activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string maxLength: 2048 format: uri maxItems: 4 description: Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled. disableManagedCrlDistributionPointUrl: type: boolean default: false description: When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included. required: - type - keyAlgorithm additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - acme configuration: type: object properties: dnsAppConnectionId: type: string format: uuid description: The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process. dnsProviderConfig: type: object properties: provider: type: string enum: - route53 - cloudflare - dns-made-easy - azure-dns description: The DNS provider for the ACME Certificate Authority. hostedZoneId: type: string minLength: 1 description: The hosted zone ID for the ACME Certificate Authority. required: - provider - hostedZoneId additionalProperties: false directoryUrl: type: string format: uri minLength: 1 description: The directory URL for the ACME Certificate Authority. accountEmail: type: string minLength: 1 description: The email address for the ACME Certificate Authority. eabKid: type: string maxLength: 64 description: The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB. dnsResolver: type: string anyOf: - format: ipv4 - format: ipv6 description: An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used. required: - dnsAppConnectionId - dnsProviderConfig - directoryUrl - accountEmail additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - azure-ad-cs configuration: type: object properties: azureAdcsConnectionId: type: string format: uuid description: Azure ADCS Connection ID required: - azureAdcsConnectionId additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-pca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA. certificateAuthorityArn: type: string minLength: 1 description: The ARN of the AWS Private Certificate Authority to use for issuing certificates. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region where the Private Certificate Authority is located. required: - appConnectionId - certificateAuthorityArn - region additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - digicert configuration: type: object properties: appConnectionId: type: string format: uuid description: DigiCert App Connection ID organizationId: type: integer exclusiveMinimum: true minimum: 0 description: CertCentral Organization ID that will be listed on issued certificates productNameId: type: string minLength: 1 description: The DigiCert product name_id used for issuance (e.g. ssl_plus, ssl_ev_plus). Fetch available products from GET /app-connections/digicert/:id/products. required: - appConnectionId - organizationId - productNameId additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - godaddy configuration: type: object properties: appConnectionId: type: string format: uuid description: GoDaddy App Connection ID productType: type: string enum: - DV_SSL description: The GoDaddy DV product used for issuance (DV_SSL for a single domain) required: - appConnectionId - productType additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - aws-acm-public-ca configuration: type: object properties: appConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates. dnsAppConnectionId: type: string format: uuid description: The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation. hostedZoneId: type: string minLength: 1 description: The Route 53 hosted zone ID to use for ACM DNS validation CNAME records. region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to use for the ACM API calls. required: - appConnectionId - dnsAppConnectionId - hostedZoneId - region additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false - type: object properties: projectId: type: string enableDirectIssuance: type: boolean default: true name: type: string id: type: string format: uuid status: type: string enum: - active - disabled - pending-certificate type: type: string enum: - venafi-tpp configuration: type: object properties: appConnectionId: type: string format: uuid description: The Venafi TPP App Connection ID. policyDN: type: string minLength: 1 description: The policy folder DN in Venafi TPP (e.g., '\\VED\\Policy\\Certificates'). required: - appConnectionId - policyDN additionalProperties: false required: - projectId - name - id - status - type - configuration additionalProperties: false required: - certificateAuthorities additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v2/workspace/{slug}/cas: get: tags: - PKI Certificate Authorities parameters: - schema: type: string enum: - active - pending-certificate in: query name: status required: false description: The status of the CA to filter by. - schema: type: string in: query name: friendlyName required: false description: The friendly name of the CA to filter by. - schema: type: string in: query name: commonName required: false description: The common name of the CA to filter by. - schema: type: number minimum: 0 maximum: 100 default: 0 in: query name: offset required: false description: The offset to start from. If you enter 10, it will start from the 10th CA. - schema: type: number minimum: 1 maximum: 100 default: 25 in: query name: limit required: false description: The number of CAs to return. - schema: type: string minLength: 5 maxLength: 64 in: path name: slug required: true description: The slug of the project to list CAs for. responses: '200': description: Default Response content: application/json: schema: type: object properties: cas: type: array items: type: object properties: id: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time projectId: type: string status: type: string enableDirectIssuance: type: boolean default: true name: type: string parentCaId: type: string format: uuid nullable: true type: type: string friendlyName: type: string organization: type: string ou: type: string country: type: string province: type: string locality: type: string commonName: type: string dn: type: string serialNumber: type: string nullable: true maxPathLength: type: number nullable: true keyAlgorithm: type: string activeCaCertId: type: string format: uuid nullable: true crlDistributionPointUrls: type: array items: type: string nullable: true disableManagedCrlDistributionPointUrl: type: boolean default: false requireTemplateForIssuance: type: boolean notAfter: type: string notBefore: type: string required: - id - createdAt - updatedAt - projectId - status - name - type - friendlyName - organization - ou - country - province - locality - commonName - dn - keyAlgorithm additionalProperties: false required: - cas additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: An access token in Infisical