Infisical Dynamic Secrets API
The Dynamic Secrets API from Infisical — 7 operation(s) for dynamic secrets.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin Dynamic Secrets 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: Dynamic Secrets
paths:
/api/v1/dynamic-secrets:
post:
tags:
- Dynamic Secrets
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
projectSlug:
type: string
minLength: 1
description: The slug of the project to create dynamic secret in.
provider:
anyOf:
- type: object
properties:
type:
type: string
enum:
- sql-database
inputs:
type: object
properties:
client:
type: string
enum:
- postgres
- mysql2
- oracledb
- mssql
- sap-ase
- vertica
host:
type: string
port:
type: number
database:
type: string
username:
type: string
password:
type: string
passwordRequirements:
type: object
properties:
length:
type: number
minimum: 1
maximum: 250
required:
type: object
properties:
lowercase:
type: number
minimum: 0
uppercase:
type: number
minimum: 0
digits:
type: number
minimum: 0
symbols:
type: number
minimum: 0
required:
- lowercase
- uppercase
- digits
- symbols
additionalProperties: false
allowedSymbols:
type: string
required:
- length
- required
additionalProperties: false
description: Password generation requirements
creationStatement:
type: string
revocationStatement:
type: string
renewStatement:
type: string
ca:
type: string
sslEnabled:
type: boolean
sslRejectUnauthorized:
type: boolean
default: true
gatewayId:
type: string
nullable: true
gatewayPoolId:
type: string
nullable: true
required:
- client
- host
- port
- database
- username
- password
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- clickhouse
inputs:
type: object
properties:
host:
type: string
port:
type: number
database:
type: string
username:
type: string
password:
type: string
passwordRequirements:
type: object
properties:
length:
type: number
minimum: 1
maximum: 250
required:
type: object
properties:
lowercase:
type: number
minimum: 0
uppercase:
type: number
minimum: 0
digits:
type: number
minimum: 0
symbols:
type: number
minimum: 0
required:
- lowercase
- uppercase
- digits
- symbols
additionalProperties: false
allowedSymbols:
type: string
required:
- length
- required
additionalProperties: false
description: Password generation requirements
creationStatement:
type: string
revocationStatement:
type: string
renewStatement:
type: string
ca:
type: string
gatewayId:
type: string
nullable: true
gatewayPoolId:
type: string
nullable: true
required:
- host
- port
- database
- username
- password
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- cassandra
inputs:
type: object
properties:
host:
type: string
port:
type: number
localDataCenter:
type: string
minLength: 1
keyspace:
type: string
username:
type: string
password:
type: string
creationStatement:
type: string
revocationStatement:
type: string
renewStatement:
type: string
ca:
type: string
sslRejectUnauthorized:
type: boolean
default: true
required:
- host
- port
- localDataCenter
- username
- password
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- sap-ase
inputs:
type: object
properties:
host:
type: string
port:
type: number
database:
type: string
username:
type: string
password:
type: string
creationStatement:
type: string
revocationStatement:
type: string
required:
- host
- port
- database
- username
- password
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- aws-iam
inputs:
anyOf:
- type: object
properties:
method:
type: string
enum:
- access-key
credentialType:
type: string
enum:
- iam-user
- temporary-credentials
default: iam-user
accessKey:
type: string
minLength: 1
secretAccessKey:
type: string
minLength: 1
region:
type: string
minLength: 1
awsPath:
type: string
permissionBoundaryPolicyArn:
type: string
policyDocument:
type: string
userGroups:
type: string
policyArns:
type: string
tags:
type: array
items:
type: object
properties:
key:
type: string
minLength: 1
maxLength: 255
value:
type: string
maxLength: 1020
default: ''
required:
- key
additionalProperties: false
required:
- method
- accessKey
- secretAccessKey
- region
additionalProperties: false
- type: object
properties:
method:
type: string
enum:
- assume-role
credentialType:
type: string
enum:
- iam-user
- temporary-credentials
default: iam-user
roleArn:
type: string
minLength: 1
region:
type: string
minLength: 1
awsPath:
type: string
permissionBoundaryPolicyArn:
type: string
policyDocument:
type: string
userGroups:
type: string
policyArns:
type: string
tags:
type: array
items:
type: object
properties:
key:
type: string
minLength: 1
maxLength: 255
value:
type: string
maxLength: 1020
default: ''
required:
- key
additionalProperties: false
required:
- method
- roleArn
- region
additionalProperties: false
- type: object
properties:
method:
type: string
enum:
- irsa
credentialType:
type: string
enum:
- iam-user
- temporary-credentials
default: iam-user
region:
type: string
minLength: 1
awsPath:
type: string
permissionBoundaryPolicyArn:
type: string
policyDocument:
type: string
userGroups:
type: string
policyArns:
type: string
tags:
type: array
items:
type: object
properties:
key:
type: string
minLength: 1
maxLength: 255
value:
type: string
maxLength: 1020
default: ''
required:
- key
additionalProperties: false
required:
- method
- region
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- redis
inputs:
type: object
properties:
host:
type: string
port:
type: number
username:
type: string
password:
type: string
creationStatement:
type: string
revocationStatement:
type: string
renewStatement:
type: string
ca:
type: string
sslRejectUnauthorized:
type: boolean
default: true
required:
- host
- port
- username
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- sap-hana
inputs:
type: object
properties:
host:
type: string
port:
type: number
username:
type: string
password:
type: string
creationStatement:
type: string
revocationStatement:
type: string
renewStatement:
type: string
ca:
type: string
sslRejectUnauthorized:
type: boolean
default: true
required:
- host
- port
- username
- password
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- aws-elasticache
inputs:
type: object
properties:
clusterName:
type: string
minLength: 1
accessKeyId:
type: string
minLength: 1
secretAccessKey:
type: string
minLength: 1
region:
type: string
creationStatement:
type: string
revocationStatement:
type: string
required:
- clusterName
- accessKeyId
- secretAccessKey
- region
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- aws-memorydb
inputs:
type: object
properties:
clusterName:
type: string
minLength: 1
auth:
anyOf:
- type: object
properties:
type:
type: string
enum:
- iam
accessKeyId:
type: string
minLength: 1
secretAccessKey:
type: string
minLength: 1
required:
- type
- accessKeyId
- secretAccessKey
additionalProperties: false
region:
type: string
minLength: 1
creationStatement:
type: string
revocationStatement:
type: string
required:
- clusterName
- auth
- region
- creationStatement
- revocationStatement
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- mongo-db-atlas
inputs:
type: object
properties:
adminPublicKey:
type: string
minLength: 1
description: Admin user public api key
adminPrivateKey:
type: string
minLength: 1
description: Admin user private api key
groupId:
type: string
minLength: 1
description: Unique 24-hexadecimal digit string that identifies your project. This is same as project id
roles:
type: array
items:
type: object
properties:
collectionName:
type: string
description: Collection on which this role applies.
databaseName:
type: string
minLength: 1
description: Database to which the user is granted access privileges.
roleName:
type: string
minLength: 1
description: ' Enum: "atlasAdmin" "backup" "clusterMonitor" "dbAdmin" "dbAdminAnyDatabase" "enableSharding" "read" "readAnyDatabase" "readWrite" "readWriteAnyDatabase" "<a custom role name>".Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.'
required:
- databaseName
- roleName
additionalProperties: false
minItems: 1
scopes:
type: array
items:
type: object
properties:
name:
type: string
minLength: 1
description: Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.
type:
type: string
minLength: 1
description: 'Category of resource that this database user can access. Enum: CLUSTER, DATA_LAKE, STREAM'
required:
- name
- type
additionalProperties: false
required:
- adminPublicKey
- adminPrivateKey
- groupId
- roles
- scopes
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- elastic-search
inputs:
type: object
properties:
host:
type: string
minLength: 1
port:
type: number
roles:
type: array
items:
type: string
minLength: 1
minItems: 1
auth:
anyOf:
- type: object
properties:
type:
type: string
enum:
- user
username:
type: string
password:
type: string
required:
- type
- username
- password
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- api-key
apiKey:
type: string
apiKeyId:
type: string
required:
- type
- apiKey
- apiKeyId
additionalProperties: false
ca:
type: string
sslRejectUnauthorized:
type: boolean
default: true
required:
- host
- port
- roles
- auth
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- mongo-db
inputs:
type: object
properties:
host:
type: string
minLength: 1
port:
type: number
nullable: true
username:
type: string
minLength: 1
password:
type: string
minLength: 1
database:
type: string
minLength: 1
ca:
type: string
nullable: true
sslRejectUnauthorized:
type: boolean
default: true
roles:
type: array
items:
type: string
minItems: 1
description: 'Enum: "atlasAdmin" "backup" "clusterMonitor" "dbAdmin" "dbAdminAnyDatabase" "enableSharding" "read" "readAnyDatabase" "readWrite" "readWriteAnyDatabase" "<a custom role name>".Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.'
required:
- host
- username
- password
- database
- roles
additionalProperties: false
required:
- type
- inputs
additionalProperties: false
- type: object
properties:
type:
type: string
enum:
- rabbit-mq
inputs:
type: object
properties:
# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-dynamic-secrets-api-openapi.yml