Infisical Integrations API
The Integrations API from Infisical — 11 operation(s) for integrations.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin Integrations 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: Integrations
paths:
/api/v1/workspace/{workspaceId}/integrations:
get:
tags:
- Integrations
description: List integrations for a project.
parameters:
- schema:
type: string
in: path
name: workspaceId
required: true
description: The ID of the project to list integrations for.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
integrations:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
isActive:
type: boolean
url:
type: string
nullable: true
app:
type: string
nullable: true
appId:
type: string
nullable: true
targetEnvironment:
type: string
nullable: true
targetEnvironmentId:
type: string
nullable: true
targetService:
type: string
nullable: true
targetServiceId:
type: string
nullable: true
owner:
type: string
nullable: true
path:
type: string
nullable: true
region:
type: string
nullable: true
scope:
type: string
nullable: true
integration:
type: string
metadata:
nullable: true
integrationAuthId:
type: string
format: uuid
envId:
type: string
format: uuid
secretPath:
type: string
default: /
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
lastUsed:
type: string
format: date-time
nullable: true
isSynced:
type: boolean
nullable: true
syncMessage:
type: string
nullable: true
lastSyncJobId:
type: string
nullable: true
environment:
type: object
properties:
id:
type: string
name:
type: string
slug:
type: string
required:
- id
- name
- slug
additionalProperties: false
required:
- id
- isActive
- integration
- integrationAuthId
- envId
- createdAt
- updatedAt
- environment
additionalProperties: false
required:
- integrations
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/workspace/{workspaceId}/authorizations:
get:
tags:
- Integrations
description: List integration auth objects for a workspace.
parameters:
- schema:
type: string
in: path
name: workspaceId
required: true
description: The ID of the project to list integration auths for.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
authorizations:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
projectId:
type: string
integration:
type: string
teamId:
type: string
nullable: true
url:
type: string
nullable: true
namespace:
type: string
nullable: true
accountId:
type: string
nullable: true
metadata:
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- projectId
- integration
- createdAt
- updatedAt
additionalProperties: false
required:
- authorizations
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/projects/{projectId}/integrations:
get:
operationId: listProjectIntegrations
tags:
- Integrations
description: List integrations for a project.
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project to list integrations for.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
integrations:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
isActive:
type: boolean
url:
type: string
nullable: true
app:
type: string
nullable: true
appId:
type: string
nullable: true
targetEnvironment:
type: string
nullable: true
targetEnvironmentId:
type: string
nullable: true
targetService:
type: string
nullable: true
targetServiceId:
type: string
nullable: true
owner:
type: string
nullable: true
path:
type: string
nullable: true
region:
type: string
nullable: true
scope:
type: string
nullable: true
integration:
type: string
metadata:
nullable: true
integrationAuthId:
type: string
format: uuid
envId:
type: string
format: uuid
secretPath:
type: string
default: /
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
lastUsed:
type: string
format: date-time
nullable: true
isSynced:
type: boolean
nullable: true
syncMessage:
type: string
nullable: true
lastSyncJobId:
type: string
nullable: true
environment:
type: object
properties:
id:
type: string
name:
type: string
slug:
type: string
required:
- id
- name
- slug
additionalProperties: false
required:
- id
- isActive
- integration
- integrationAuthId
- envId
- createdAt
- updatedAt
- environment
additionalProperties: false
required:
- integrations
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/projects/{projectId}/authorizations:
get:
operationId: listProjectIntegrationAuthorizations
tags:
- Integrations
description: List integration auth objects for a project.
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project to list integration auths for.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
authorizations:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
projectId:
type: string
integration:
type: string
teamId:
type: string
nullable: true
url:
type: string
nullable: true
namespace:
type: string
nullable: true
accountId:
type: string
nullable: true
metadata:
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- projectId
- integration
- createdAt
- updatedAt
additionalProperties: false
required:
- authorizations
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/integration:
post:
operationId: createIntegration
tags:
- Integrations
description: Create an integration to sync secrets.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
integrationAuthId:
type: string
description: The ID of the integration auth object to link with integration.
app:
type: string
description: The name of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations.
isActive:
type: boolean
description: Whether the integration should be active or disabled.
default: true
appId:
type: string
description: The ID of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations.
secretPath:
type: string
default: /
description: The path of the secrets to sync secrets from.
sourceEnvironment:
type: string
description: The environment to sync secret from.
targetEnvironment:
type: string
description: The target environment of the integration provider. Used in cloudflare pages, TeamCity, Gitlab integrations.
targetEnvironmentId:
type: string
description: The target environment ID of the integration provider. Used in cloudflare pages, teamcity, gitlab integrations.
targetService:
type: string
description: The service based grouping identifier of the external provider. Used in Terraform cloud, Checkly, Railway and NorthFlank.
targetServiceId:
type: string
description: The service based grouping identifier ID of the external provider. Used in Terraform cloud, Checkly, Railway and NorthFlank.
owner:
type: string
description: External integration providers service entity owner. Used in Github.
url:
type: string
format: uri
description: The self-hosted URL of the platform to integrate with.
path:
type: string
description: Path to save the synced secrets. Used by Gitlab, AWS Parameter Store, Vault.
region:
type: string
description: AWS region to sync secrets to.
scope:
type: string
description: Scope of the provider. Used by Github, Qovery.
metadata:
type: object
properties:
initialSyncBehavior:
type: string
description: Type of syncing behavoir with the integration.
secretPrefix:
type: string
description: The prefix for the saved secret. Used by GCP.
secretSuffix:
type: string
description: The suffix for the saved secret. Used by GCP.
mappingBehavior:
type: string
enum:
- one-to-one
- many-to-one
# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-integrations-api-openapi.yml