Infisical PKI Installations API
The PKI Installations API from Infisical — 2 operation(s) for pki installations.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin PKI Installations 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 Installations
paths:
/api/v1/cert-manager/installations:
get:
operationId: listPkiInstallations
tags:
- PKI Installations
description: List PKI certificate installations for a project
parameters:
- schema:
type: string
format: uuid
in: query
name: discoveryId
required: false
description: Filter by discovery configuration ID
- schema:
type: string
format: uuid
in: query
name: certificateId
required: false
description: Filter by certificate ID
- schema:
type: number
minimum: 0
default: 0
in: query
name: offset
required: false
description: Pagination offset
- schema:
type: number
minimum: 1
maximum: 100
default: 25
in: query
name: limit
required: false
description: Pagination limit
- schema:
type: string
in: query
name: search
required: false
description: Search filter for name, hostname, or IP address
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
installations:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
locationType:
type: string
locationDetails: {}
locationFingerprint:
type: string
name:
type: string
nullable: true
type:
type: string
default: unknown
metadata:
nullable: true
lastSeenAt:
type: string
format: date-time
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
certificatesCount:
type: number
primaryCertName:
type: string
nullable: true
discoveryName:
type: string
nullable: true
required:
- id
- locationType
- locationFingerprint
- lastSeenAt
- createdAt
- updatedAt
additionalProperties: false
totalCount:
type: number
required:
- installations
- totalCount
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/installations/{installationId}:
get:
operationId: getPkiInstallation
tags:
- PKI Installations
description: Get a PKI certificate installation by ID with linked certificates
parameters:
- schema:
type: string
format: uuid
in: path
name: installationId
required: true
description: The ID of the installation
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
locationType:
type: string
locationDetails: {}
locationFingerprint:
type: string
name:
type: string
nullable: true
type:
type: string
default: unknown
metadata:
nullable: true
lastSeenAt:
type: string
format: date-time
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
discoveryName:
type: string
nullable: true
certificates:
type: array
items:
type: object
properties:
certificateId:
type: string
format: uuid
firstSeenAt:
type: string
format: date-time
lastSeenAt:
type: string
format: date-time
commonName:
type: string
nullable: true
serialNumber:
type: string
nullable: true
notBefore:
type: string
format: date-time
nullable: true
notAfter:
type: string
format: date-time
nullable: true
status:
type: string
nullable: true
friendlyName:
type: string
nullable: true
fingerprintSha256:
type: string
nullable: true
subjectOrganization:
type: string
nullable: true
subjectOrganizationalUnit:
type: string
nullable: true
subjectCountry:
type: string
nullable: true
subjectState:
type: string
nullable: true
subjectLocality:
type: string
nullable: true
required:
- certificateId
- firstSeenAt
- lastSeenAt
additionalProperties: false
required:
- id
- locationType
- locationFingerprint
- lastSeenAt
- 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
patch:
operationId: updatePkiInstallation
tags:
- PKI Installations
description: Update a PKI certificate installation
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
maxLength: 255
description: Name of the installation
additionalProperties: false
parameters:
- schema:
type: string
format: uuid
in: path
name: installationId
required: true
description: The ID of the installation
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
locationType:
type: string
locationDetails: {}
locationFingerprint:
type: string
name:
type: string
nullable: true
type:
type: string
default: unknown
metadata:
nullable: true
lastSeenAt:
type: string
format: date-time
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- locationType
- locationFingerprint
- lastSeenAt
- 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
delete:
operationId: deletePkiInstallation
tags:
- PKI Installations
description: Delete a PKI certificate installation
parameters:
- schema:
type: string
format: uuid
in: path
name: installationId
required: true
description: The ID of the installation
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
locationType:
type: string
locationDetails: {}
locationFingerprint:
type: string
name:
type: string
nullable: true
type:
type: string
default: unknown
metadata:
nullable: true
lastSeenAt:
type: string
format: date-time
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- locationType
- locationFingerprint
- lastSeenAt
- 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
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: An access token in Infisical