Infisical PKI Syncs API
The PKI Syncs API from Infisical — 72 operation(s) for pki syncs.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin PKI Syncs 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 Syncs
paths:
/api/v1/cert-manager/syncs/options:
get:
operationId: listPkiSyncOptions
tags:
- PKI Syncs
description: List the available PKI Sync Options.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
pkiSyncOptions:
type: array
items:
type: object
properties:
name:
type: string
connection:
type: string
enum:
- github
- github-radar
- aws
- databricks
- gcp
- azure-key-vault
- azure-app-configuration
- azure-client-secrets
- azure-devops
- azure-adcs
- azure-dns
- humanitec
- terraform-cloud
- vercel
- postgres
- mssql
- mysql
- camunda
- windmill
- auth0
- hashicorp-vault
- ldap
- teamcity
- oci
- oracledb
- 1password
- heroku
- render
- flyio
- gitlab
- cloudflare
- dns-made-easy
- zabbix
- railway
- bitbucket
- checkly
- supabase
- digital-ocean
- netlify
- okta
- redis
- mongodb
- laravel-forge
- chef
- northflank
- octopus-deploy
- ssh
- dbt
- smb
- open-router
- circleci
- azure-entra-id
- venafi
- venafi-tpp
- external-infisical
- doppler
- netscaler
- anthropic
- ovh
- devin
- ona
- digicert
- travis-ci
- salesforce
- snowflake
- datadog
- f5-big-ip
- godaddy
- convex
destination:
type: string
enum:
- azure-key-vault
- aws-certificate-manager
- aws-secrets-manager
- aws-elastic-load-balancer
- chef
- cloudflare-custom-certificate
- netscaler
- f5-big-ip
canImportCertificates:
type: boolean
canRemoveCertificates:
type: boolean
defaultCertificateNameSchema:
type: string
forbiddenCharacters:
type: string
allowedCharacterPattern:
type: string
maxCertificateNameLength:
type: number
minCertificateNameLength:
type: number
required:
- name
- connection
- destination
- canImportCertificates
- canRemoveCertificates
additionalProperties: false
required:
- pkiSyncOptions
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/syncs:
get:
operationId: listPkiSyncs
tags:
- PKI Syncs
description: List all the PKI Syncs for the specified project.
parameters:
- schema:
type: string
format: uuid
in: query
name: certificateId
required: false
- schema:
type: string
format: uuid
in: query
name: applicationId
required: false
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
pkiSyncs:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
description:
type: string
nullable: true
destination:
type: string
enum:
- azure-key-vault
- aws-certificate-manager
- aws-secrets-manager
- aws-elastic-load-balancer
- chef
- cloudflare-custom-certificate
- netscaler
- f5-big-ip
isAutoSyncEnabled:
type: boolean
destinationConfig:
type: object
additionalProperties: {}
syncOptions:
type: object
additionalProperties: {}
applicationId:
type: string
format: uuid
nullable: true
subscriberId:
type: string
format: uuid
nullable: true
connectionId:
type: string
format: uuid
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
syncStatus:
type: string
nullable: true
lastSyncJobId:
type: string
nullable: true
lastSyncMessage:
type: string
nullable: true
lastSyncedAt:
type: string
format: date-time
nullable: true
importStatus:
type: string
nullable: true
lastImportJobId:
type: string
nullable: true
lastImportMessage:
type: string
nullable: true
lastImportedAt:
type: string
format: date-time
nullable: true
removeStatus:
type: string
nullable: true
lastRemoveJobId:
type: string
nullable: true
lastRemoveMessage:
type: string
nullable: true
lastRemovedAt:
type: string
format: date-time
nullable: true
appConnectionName:
type: string
appConnectionApp:
type: string
connection:
type: object
properties:
id:
type: string
name:
type: string
app:
type: string
encryptedCredentials:
nullable: true
orgId:
type: string
format: uuid
method:
type: string
description:
type: string
nullable: true
version:
type: number
gatewayId:
type: string
format: uuid
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
isPlatformManagedCredentials:
type: boolean
nullable: true
required:
- id
- name
- app
- orgId
- method
- version
- createdAt
- updatedAt
additionalProperties: false
subscriber:
type: object
properties:
id:
type: string
name:
type: string
required:
- id
- name
additionalProperties: false
nullable: true
hasCertificate:
type: boolean
required:
- id
- name
- destination
- isAutoSyncEnabled
- destinationConfig
- syncOptions
- connectionId
- createdAt
- updatedAt
- appConnectionName
- appConnectionApp
- connection
additionalProperties: false
required:
- pkiSyncs
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/syncs/{pkiSyncId}:
get:
operationId: getPkiSync
tags:
- PKI Syncs
description: Get a PKI Sync by ID.
parameters:
- schema:
type: string
in: path
name: pkiSyncId
required: true
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
description:
type: string
nullable: true
destination:
type: string
enum:
- azure-key-vault
- aws-certificate-manager
- aws-secrets-manager
- aws-elastic-load-balancer
- chef
- cloudflare-custom-certificate
- netscaler
- f5-big-ip
isAutoSyncEnabled:
type: boolean
destinationConfig:
type: object
additionalProperties: {}
syncOptions:
type: object
additionalProperties: {}
applicationId:
type: string
format: uuid
nullable: true
subscriberId:
type: string
format: uuid
nullable: true
connectionId:
type: string
format: uuid
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
syncStatus:
type: string
nullable: true
lastSyncJobId:
type: string
nullable: true
lastSyncMessage:
type: string
nullable: true
lastSyncedAt:
type: string
format: date-time
nullable: true
importStatus:
type: string
nullable: true
lastImportJobId:
type: string
nullable: true
lastImportMessage:
type: string
nullable: true
lastImportedAt:
type: string
format: date-time
nullable: true
removeStatus:
type: string
nullable: true
lastRemoveJobId:
type: string
nullable: true
lastRemoveMessage:
type: string
nullable: true
lastRemovedAt:
type: string
format: date-time
nullable: true
appConnectionName:
type: string
appConnectionApp:
type: string
connection:
type: object
properties:
id:
type: string
name:
type: string
app:
type: string
encryptedCredentials:
nullable: true
orgId:
type: string
format: uuid
method:
type: string
description:
type: string
nullable: true
version:
type: number
gatewayId:
type: string
format: uuid
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
isPlatformManagedCredentials:
type: boolean
nullable: true
required:
- id
- name
- app
- orgId
- method
- version
- createdAt
- updatedAt
additionalProperties: false
subscriber:
type: object
properties:
id:
type: string
name:
type: string
required:
- id
- name
additionalProperties: false
nullable: true
hasCertificate:
type: boolean
required:
- id
- name
- destination
- isAutoSyncEnabled
- destinationConfig
- syncOptions
- connectionId
- createdAt
- updatedAt
- appConnectionName
- appConnectionApp
- connection
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/syncs/{pkiSyncId}/certificates:
get:
operationId: listPkiSyncCertificates
tags:
- PKI Syncs
description: List all certificates associated with a PKI Sync.
parameters:
- schema:
type: number
minimum: 0
default: 0
in: query
name: offset
required: false
- schema:
type: number
minimum: 1
maximum: 100
default: 20
in: query
name: limit
required: false
- schema:
type: string
format: uuid
in: path
name: pkiSyncId
required: true
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
certificates:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
pkiSyncId:
type: string
format: uuid
certificateId:
type: string
format: uuid
syncStatus:
type: string
enum:
- pending
- syncing
- succeeded
- failed
- running
lastSyncMessage:
type: string
nullable: true
lastSyncedAt:
type: string
format: date-time
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
certificateSerialNumber:
type: string
certificateCommonName:
type: string
certificateAltNames:
type: string
certificateStatus:
type: string
certificateNotBefore:
type: string
format: date-time
certificateNotAfter:
type: string
format: date-time
certificateRenewBeforeDays:
type: number
# --- truncated at 32 KB (939 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-pki-syncs-api-openapi.yml