Infisical Secret Imports API
The Secret Imports API from Infisical — 6 operation(s) for secret imports.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin Secret Imports 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: Secret Imports
paths:
/api/v1/secret-imports:
post:
tags:
- Secret Imports
description: Create secret imports
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
workspaceId:
type: string
description: The ID of the project you are working in.
environment:
type: string
description: The slug of the environment to import into.
path:
type: string
default: /
description: The path to import into.
import:
type: object
properties:
environment:
type: string
description: The slug of the environment to import from.
path:
type: string
description: The path to import from.
required:
- environment
- path
additionalProperties: false
isReplication:
type: boolean
default: false
description: When true, secrets from the source will be automatically sent to the destination. If approval policies exist at the destination, the secrets will be sent as approval requests instead of being applied immediately.
required:
- workspaceId
- environment
- import
additionalProperties: false
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
secretImport:
type: object
properties:
id:
type: string
format: uuid
version:
type: number
default: 1
nullable: true
importPath:
type: string
position:
type: number
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
folderId:
type: string
format: uuid
isReplication:
type: boolean
default: false
nullable: true
isReplicationSuccess:
type: boolean
nullable: true
replicationStatus:
type: string
nullable: true
lastReplicated:
type: string
format: date-time
nullable: true
isReserved:
type: boolean
default: false
nullable: true
importEnv:
type: object
properties:
name:
type: string
slug:
type: string
id:
type: string
required:
- name
- slug
- id
additionalProperties: false
required:
- id
- importPath
- position
- createdAt
- updatedAt
- folderId
- importEnv
additionalProperties: false
required:
- message
- secretImport
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:
tags:
- Secret Imports
description: Get secret imports
parameters:
- schema:
type: string
in: query
name: workspaceId
required: true
description: The ID of the project to list secret imports from.
- schema:
type: string
in: query
name: environment
required: true
description: The slug of the environment to list secret imports from.
- schema:
type: string
default: /
in: query
name: path
required: false
description: The path to list secret imports from.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
secretImports:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
version:
type: number
default: 1
nullable: true
importPath:
type: string
position:
type: number
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
folderId:
type: string
format: uuid
isReplication:
type: boolean
default: false
nullable: true
isReplicationSuccess:
type: boolean
nullable: true
replicationStatus:
type: string
nullable: true
lastReplicated:
type: string
format: date-time
nullable: true
isReserved:
type: boolean
default: false
nullable: true
importEnv:
type: object
properties:
name:
type: string
slug:
type: string
id:
type: string
required:
- name
- slug
- id
additionalProperties: false
required:
- id
- importPath
- position
- createdAt
- updatedAt
- folderId
- importEnv
additionalProperties: false
required:
- message
- secretImports
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/secret-imports/{secretImportId}:
patch:
tags:
- Secret Imports
description: Update secret imports
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
workspaceId:
type: string
description: The ID of the project where the secret import is located.
environment:
type: string
description: The slug of the environment where the secret import is located.
path:
type: string
default: /
description: The path of the secret import to update.
import:
type: object
properties:
environment:
type: string
description: The new environment slug to import from.
path:
type: string
description: The new path to import from.
position:
type: number
description: The new position of the secret import. The lowest number will be displayed as the first import.
additionalProperties: false
required:
- workspaceId
- environment
- import
additionalProperties: false
parameters:
- schema:
type: string
in: path
name: secretImportId
required: true
description: The ID of the secret import to update.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
secretImport:
type: object
properties:
id:
type: string
format: uuid
version:
type: number
default: 1
nullable: true
importPath:
type: string
position:
type: number
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
folderId:
type: string
format: uuid
isReplication:
type: boolean
default: false
nullable: true
isReplicationSuccess:
type: boolean
nullable: true
replicationStatus:
type: string
nullable: true
lastReplicated:
type: string
format: date-time
nullable: true
isReserved:
type: boolean
default: false
nullable: true
importEnv:
type: object
properties:
name:
type: string
slug:
type: string
id:
type: string
required:
- name
- slug
- id
additionalProperties: false
required:
- id
- importPath
- position
- createdAt
- updatedAt
- folderId
- importEnv
additionalProperties: false
required:
- message
- secretImport
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:
- Secret Imports
description: Delete secret imports
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
workspaceId:
type: string
description: The ID of the project to delete the secret import from.
environment:
type: string
description: The slug of the environment where the secret import is located.
path:
type: string
default: /
description: The path of the secret import to delete.
required:
- workspaceId
- environment
additionalProperties: false
parameters:
- schema:
type: string
in: path
name: secretImportId
required: true
description: The ID of the secret import to delete.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
secretImport:
type: object
properties:
id:
type: string
format: uuid
version:
type: number
default: 1
nullable: true
importPath:
type: string
position:
type: number
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
folderId:
type: string
format: uuid
isReplication:
type: boolean
default: false
nullable: true
isReplicationSuccess:
type: boolean
nullable: true
replicationStatus:
type: string
nullable: true
lastReplicated:
type: string
format: date-time
nullable: true
isReserved:
type: boolean
default: false
nullable: true
importEnv:
type: object
properties:
name:
type: string
slug:
type: string
id:
type: string
required:
- name
- slug
- id
additionalProperties: false
required:
- id
- importPath
- position
- createdAt
- updatedAt
- folderId
- importEnv
additionalProperties: false
required:
- message
- secretImport
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:
tags:
- Secret Imports
description: Get single secret import
parameters:
- schema:
type: string
in: path
name: secretImportId
required: true
description: The ID of the secret import to fetch.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
secretImport:
type: object
properties:
id:
type: string
format: uuid
version:
type:
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-secret-imports-api-openapi.yml